Class FieldNameDescriptor

Object
   |
   +--FieldDescriptor
         |
         +--FieldNameDescriptor

class FieldNameDescriptor

extends FieldDescriptor

A field descriptor that specifies a field withing a schema by name. A descriptor of this type can only be used if the related schema has been specified by using a SchemaListDescriptor or a field name array.
An field descriptor can also be used to specify an extra field. In this case, a descriptor of this type can always be used; if the related schema has been specified by using a SchemaIdDescriptor or a schema identifier, then a descriptor of this type always refers to an extra field.
Note that directly passing a String object (provided it does not evaluate to a number) is supported, as a shorthand for a FieldNameDescriptor, by all interface methods that require a FieldDescriptor object.
Defined in lspushpage.js

Constructor Detail

FieldNameDescriptor

FieldNameDescriptor(<String> fieldName)

Creates a field descriptor object that specifies a field by name.

Parameters:
fieldName - a field name.

getName

String getName()

Inquiry method that gets the field name specified by this field descriptor.

Returns:
A field name.