The FieldType Object is a model that describes the attributes of a field. This object is serializable. More...
Classes | |
| enum | DataType |
| An enum that defines the data type specified for this Field Type. More... | |
Public Member Functions | |
| FieldType | clone () |
| Performs a field-for-field copy of instances of this class. More... | |
| FieldType () | |
| The default Constructor creates an empty FieldType object and initializes all parameters with default values. More... | |
| void | setName (String name) |
| Sets FieldType name. More... | |
| String | getName () |
| Gets FieldType name. More... | |
| void | setDisplayName (String displayName) |
| Sets FieldType display name. More... | |
| String | getDisplayName () |
| Gets FieldType display name. More... | |
| void | setLabel (String label) |
| Sets displayable label for the FieldType. More... | |
| String | getLabel () |
| Gets displayable label of the FieldType. More... | |
| void | setRequired (Boolean isRequired) |
| Sets required flag for the FieldType to indicate if the value must be entered for associated Field object. More... | |
| boolean | isRequired () |
| Gets required flag of the FieldType. More... | |
| void | setDataType (DataType dataType) |
| Sets data type for FieldType. More... | |
| DataType | getDataType () |
| Gets data type of FieldType. More... | |
| void | setHidden (Boolean isHidden) |
| Sets the hidden flag in FieldType to define weather the associated Field should be visible to user. More... | |
| boolean | isHidden () |
| Gets the hidden flag of FieldType. More... | |
| void | setReadOnly (Boolean isReadOnly) |
| Sets the readonly flag in FieldType to define weather the associated Field is updatable by the user. More... | |
| boolean | isReadOnly () |
| Gets the readonly flag of FieldType. More... | |
| void | setOptions (String[] options) |
| Sets the values associated with a choice list for the respective Field Object. More... | |
| String[] | getOptions () |
| Gets the values associated with a choice list for the respective Field Object. More... | |
| void | setForceMatch (Boolean isForceMatch) |
| Sets the forcematch flag to specify if the user is limited to choices in the options choice list, or the other values are valid. More... | |
| boolean | isForceMatch () |
| Gets the forcematch flag to determine if the user is limited to choices in the options choice list, or the other values are valid. More... | |
| void | setMin (String min) |
| Sets minimum value for the index Field. More... | |
| String | getMin () |
| Gets minimum value of the index Field. More... | |
| void | setMax (String max) |
| Sets maximum value for the index Field. More... | |
| String | getMax () |
| Gets maximum value of the index Field. More... | |
| void | setDefault (String def) |
| Sets default value for the associated Field Object. More... | |
| String | getDefault () |
| Gets default value of the associated Field Object. More... | |
| void | setCustomTag (String customTag) |
| Sets value of the custom tag for the FieldType. Its an open field for use by the application. More... | |
| String | getCustomTag () |
| Gets value of the custom tag of the FieldType. Its an open field for use by the application. More... | |
Detailed Description
The FieldType Object is a model that describes the attributes of a field. This object is serializable.
An array of FieldType gets instantiated with the DocumentType Object.
FieldType objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.
Constructor & Destructor Documentation
| FieldType | ( | ) |
The default Constructor creates an empty FieldType object and initializes all parameters with default values.
Member Function Documentation
| FieldType clone | ( | ) |
Performs a field-for-field copy of instances of this class.
| String getCustomTag | ( | ) |
Gets value of the custom tag of the FieldType. Its an open field for use by the application.
| String getDefault | ( | ) |
Gets default value of the associated Field Object.
| String getDisplayName | ( | ) |
Gets FieldType display name.
| String getLabel | ( | ) |
Gets displayable label of the FieldType.
| String getMax | ( | ) |
Gets maximum value of the index Field.
| String getMin | ( | ) |
Gets minimum value of the index Field.
| String getName | ( | ) |
Gets FieldType name.
| String [] getOptions | ( | ) |
Gets the values associated with a choice list for the respective Field Object.
| boolean isForceMatch | ( | ) |
Gets the forcematch flag to determine if the user is limited to choices in the options choice list, or the other values are valid.
| boolean isHidden | ( | ) |
Gets the hidden flag of FieldType.
| boolean isReadOnly | ( | ) |
Gets the readonly flag of FieldType.
| boolean isRequired | ( | ) |
Gets required flag of the FieldType.
| void setCustomTag | ( | String | customTag | ) |
Sets value of the custom tag for the FieldType. Its an open field for use by the application.
| void setDefault | ( | String | def | ) |
Sets default value for the associated Field Object.
| void setDisplayName | ( | String | displayName | ) |
Sets FieldType display name.
| void setForceMatch | ( | Boolean | isForceMatch | ) |
Sets the forcematch flag to specify if the user is limited to choices in the options choice list, or the other values are valid.
| void setHidden | ( | Boolean | isHidden | ) |
| void setLabel | ( | String | label | ) |
Sets displayable label for the FieldType.
| void setMax | ( | String | max | ) |
Sets maximum value for the index Field.
For string: specifies the maximum length. For int and float: specifies the maximum allowed value. Value can be negative. For date: specifies the newest allowed date.
| void setMin | ( | String | min | ) |
Sets minimum value for the index Field.
For string: specifies the minimum length. For int and float: specifies the minimum allowed value. Value can be negative. For date: specifies the oldest allowed date.
| void setName | ( | String | name | ) |
Sets FieldType name.
| void setOptions | ( | String[] | options | ) |
Sets the values associated with a choice list for the respective Field Object.
| void setReadOnly | ( | Boolean | isReadOnly | ) |
| void setRequired | ( | Boolean | isRequired | ) |
The documentation for this class was generated from the following file: