FieldDefinition (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.utils.RecordPackWrapper
- - com.canto.cumulus.FieldDefinition

All Implemented Interfaces:

FieldTypes
```
public class FieldDefinition
extends RecordPackWrapper
implements FieldTypes
```
The FieldDefinition object can be used it to access a specific field of a layout.

Since:

1.0

Field Summary
- Fields inherited from interface com.canto.cumulus.FieldTypes
  FieldTypeAudio, FieldTypeBinary, FieldTypeBool, FieldTypeDate, FieldTypeDouble, FieldTypeEnum, FieldTypeInteger, FieldTypeLong, FieldTypePicture, FieldTypeString, FieldTypeTable, VALUE_INTERPRETATION_ASSETREFERENCE, VALUE_INTERPRETATION_DATA_SIZE, VALUE_INTERPRETATION_DATE_ONLY, VALUE_INTERPRETATION_DATE_TIME, VALUE_INTERPRETATION_DEFAULT, VALUE_INTERPRETATION_LENGTH_IN_INCH, VALUE_INTERPRETATION_RESOLUTION, VALUE_INTERPRETATION_STRING_ENUM_LABEL, VALUE_INTERPRETATION_STRING_ENUM_MULTIPLE_VALUES, VALUE_INTERPRETATION_STRING_ENUM_RATING, VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY, VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_MULTIPLE_VALUES, VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_SINGLE_VALUE, VALUE_INTERPRETATION_STRING_USER_UID, VALUE_INTERPRETATION_TIME_ONLY

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`JPack`	`getAdditionalFieldProperties()` Returns the pack that provides the additional field properties.
`ItemCollection`	`getAllVocabulariesItemCollection()` Returns an `ItemCollection` containing all items of the $Vocabulary catalog.
`java.lang.String`	`getCanonicalFieldReference(boolean includeRootTable)` Returns a field reference for this field which is a combination of this fields table with the field `GUID` appended.
`GUID`	`getCanonicalFieldUID()` This returns the GUID that can be used when referencing this field in external structures like record view sets or print templates.
`CumulusSession`	`getCumulusSession()` Returns the current `CumulusSession` object.
`java.lang.String`	`getDescription()` Return the description text for the current language.
`java.lang.String`	`getDescription(int languageID)` Return the description text for the given language.
`boolean`	`getFieldLinkingForAddingUseAllInputValues()` Returns whether this field should be linked to all filter values when adding records.
`boolean`	`getFieldLinkingForUpdatingUseAllInputValues()` Returns whether this field should be linked to all filter values when updating records.
`boolean`	`getFieldLinkingUseAllMatchingFields()` Returns whether all newly installed filters should be automatically linked to this field.
`java.lang.String`	`getFieldReference(boolean includeRootTable, boolean canonical)` Returns a field reference for this field which is a combination of this fields table with the field `GUID` appended.
`int`	`getFieldType()` Returns the type of the field.
`GUID`	`getFieldUID()` Returns the field `GUID`.
`int`	`getFlags()` Returns the additional field flag.
`java.lang.String`	`getFormula()` Returns the formula for this field.
`int`	`getIndexing()` Returns the flag determining the indexing configuration.
`java.lang.String`	`getInitialValue()` Returns the "Initial Value" of the field.
`Layout`	`getLayout()` Returns the layout that created this field definition.
`GUID`	`getMultipleLanguagesBaseFieldGUID()` Returns for a multi language field the base field GUID.
`int`	`getMultipleLanguagesFieldLanguage()` Returns for a multi language field the fields content language.
`MultipleLanguagesFieldType`	`getMultipleLanguagesFieldType()` Returns the multi language field type.
`GUID`	`getMultipleLanguagesMappedFieldGUID()` Returns for a multi language field the mapped field GUID.
`java.lang.String`	`getName()` Returns the name of the field using the default language ID.
`java.lang.String`	`getName(int languageID)` Returns the name of the field in the given language ID.
`java.lang.String`	`getName(int languageID, boolean showParentTables, boolean includeRootTable)` Returns the name of the field in the given language ID and optionally prefixes the name with the parent table names.
`boolean`	`getRestrictVocabularyItems()` Returns whether this vocabulary field is restricted.
`int`	`getShortID()` Returns the internal ID of the field.
`java.util.Set<java.lang.Integer>`	`getSortIndexLanguages()` Returns for a field of type string a set of language IDs with specific sorting.
`java.lang.String`	`getStringEnumDescription(int enumID)` Returns the textual string enum description for the current language.
`java.lang.String`	`getStringEnumDescription(int enumID, int languageID)` Returns the textual string enum description for the specified language.
`java.util.List<java.lang.Integer>`	`getStringEnumIDs()` Returns for a field of type string enum the list of string enum IDs in sorted order for the current language.
`java.util.List<java.lang.Integer>`	`getStringEnumIDs(int languageID)` Returns for a field of type string enum the list of string enum IDs in sorted order for the specified language.
`java.lang.String`	`getStringEnumName(int enumID)` Returns the textual string enum representation for the current language.
`java.lang.String`	`getStringEnumName(int enumID, int languageID)` Returns the textual string enum representation for the specified language.
`boolean`	`getUseFieldLinkingForAdding()` Returns whether this field should be linked to filters when adding records.
`boolean`	`getUseFieldLinkingForSaving()` Returns whether this field should be linked to filters when saving records.
`boolean`	`getUseFieldLinkingForUpdating()` Returns whether this field should be linked to filters when updating records.
`boolean`	`getUseInitialValue()` Returns the "Use Initial Value" state of the field.
`int`	`getValueInterpretation()` Returns the value interpretation for this field.
`FieldValueMode`	`getValueMode()` Returns the `value mode` for this field.
`java.lang.String`	`getValueTableName()` Returns for a field definition of type table the internal table name of the sub table.
`ItemCollection`	`getVocabularyItemCollection()` Returns an empty `ItemCollection` of the $Vocabulary catalog that has set the defined query (see `getVocabularyQuery()`) as filter.
`java.lang.String`	`getVocabularyQuery()` Returns the query string defined for the field of value interpretation `FieldTypes.VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_MULTIPLE_VALUES` or `FieldTypes.VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_SINGLE_VALUE`.
`int`	`hashCode()`
`boolean`	`isContentIndexed()` Returns whether this field is content indexed.
`boolean`	`isContentIndexedNoWordBreak()` Returns whether this field is content indexed without breaking words.
`boolean`	`isEditable()` Returns whether this field should be editable when providing some user interface to a user.
`boolean`	`isMandatory()` Returns whether this field is mandatory.
`boolean`	`isSortIndexed()` Returns whether this field is sort indexed.
`boolean`	`isVisibleInFindWindow()` Returns whether this field is shown in the clients find window.
`boolean`	`isVisibleInSortPopup()` Returns whether this field is shown in the clients sorting field popup.
`boolean`	`isWordIndexed()` Returns whether this field is word indexed.
`java.lang.String`	`toString()` Returns this fields name.
`boolean`	`useRegionalSettings()` Returns whether this field value should be shown using the regional setting.
`java.lang.String`	`validate(int indexType)` Validates the given index of this field and returns an error message.

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper
toXMLString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFieldUID
```
public GUID getFieldUID()
```
Returns the field GUID.

Returns:
the field GUID.

getCanonicalFieldUID
```
public GUID getCanonicalFieldUID()
```
This returns the GUID that can be used when referencing this field in external structures like record view sets or print templates. The result is either the plain field GUID or for a multiple languages base field the mapped virtual field UID for the base field language.

Returns:
field GUID or for a multiple languages base field the mapped virtual field UID for the base field language
Since:

8.6

getCanonicalFieldReference
```
public java.lang.String getCanonicalFieldReference(boolean includeRootTable)
```
Returns a field reference for this field which is a combination of this fields table with the field GUID appended. The root table name Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES can optionally be omitted. This is useful when creating sub-table queries where the root table name must not be used for a sub-table field reference.

Parameters:
includeRootTable - if true the root table name Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES is included, otherwise omitted

Returns:
field reference for this field
Since:

8.6

getFieldReference
```
public java.lang.String getFieldReference(boolean includeRootTable,
                                 boolean canonical)
```
Returns a field reference for this field which is a combination of this fields table with the field GUID appended. The root table name Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES can optionally be omitted. This is useful when creating sub-table queries where the root table name must not be used for a sub-table field reference.

Parameters:
includeRootTable - if true the root table name Cumulus.TABLE_NAME_ASSET_RECORDS or Cumulus.TABLE_NAME_CATEGORIES is included, otherwise omitted
canonical - if true the returned reference uses canonical UIDs instead of the real UIDs

Returns:
field reference for this field
Since:

9.0

getShortID
```
public int getShortID()
```
Returns the internal ID of the field. This value is used internally in Cumulus to access fields. This value can be used alternatively to the field GUID to access the fields of a layout.

Returns:
the internal ID of the field.

getFieldType
```
public int getFieldType()
```
Returns the type of the field.
Returns:
the type of a field. Possible values are:

getValueInterpretation
```
public int getValueInterpretation()
```
Returns the value interpretation for this field. The value interpretation is one of the following values:
Returns:
value interpretation

getIndexing
```
public int getIndexing()
```
Returns the flag determining the indexing configuration. Use the specific isSortIndexed() etc. instead.

Returns:
indexing flag
Since:

8.0

getFlags
```
public int getFlags()
```
Returns the additional field flag. Use the specific isMandatory() etc. instead.

Returns:
additional field flag
Since:

8.0

isSortIndexed
```
public boolean isSortIndexed()
```
Returns whether this field is sort indexed.

Returns:
returns whether this field is sort indexed
Since:

8.0

isContentIndexed
```
public boolean isContentIndexed()
```
Returns whether this field is content indexed.

Returns:
returns whether this field is content indexed
Since:

8.0

isContentIndexedNoWordBreak
```
public boolean isContentIndexedNoWordBreak()
```
Returns whether this field is content indexed without breaking words. This value only needs to be evaluated if also isContentIndexed() returned true.

Returns:
returns whether this field is content indexed without breaking words
Since:

8.1.1

isWordIndexed
```
public boolean isWordIndexed()
```
Returns whether this field is word indexed.

Returns:
returns whether this field is word indexed
Since:

8.0

isMandatory
```
public boolean isMandatory()
```
Returns whether this field is mandatory.

Returns:
returns whether this field is mandatory
Since:

8.0

isVisibleInSortPopup
```
public boolean isVisibleInSortPopup()
```
Returns whether this field is shown in the clients sorting field popup.

Returns:
returns whether this field is shown in the clients sorting field popup
Since:

8.0

isVisibleInFindWindow
```
public boolean isVisibleInFindWindow()
```
Returns whether this field is shown in the clients find window.

Returns:
returns whether this field is shown in the clients find window
Since:

8.0

useRegionalSettings
```
public boolean useRegionalSettings()
```
Returns whether this field value should be shown using the regional setting.

Returns:
true if the field value should be shown using the regional setting
Since:

11.1.5

getName

public java.lang.String getName()

Returns the name of the field using the default language ID.
For example:

 FieldDefinition myFieldDefinition = myLayout.getFieldDefinitions().getFieldDefinitionByID(GUID.UID_REC_RECORD_NAME);
 String sFieldName = myFieldDefinition.getName();

Returns:: the name of the field.

getName
```
public java.lang.String getName(int languageID)
```
Returns the name of the field in the given language ID.

Parameters:
languageID - the language ID for which the field name is to be returned.

Returns:
the name of the field.

getName
```
public java.lang.String getName(int languageID,
                       boolean showParentTables,
                       boolean includeRootTable)
```
Returns the name of the field in the given language ID and optionally prefixes the name with the parent table names.

Parameters:
languageID - the language ID for which the field name is to be returned.
showParentTables - specifies whether the resulting String should also contain the parent table names
includeRootTable - whether to display the Records or Categories root table in the returned name

Returns:
the name of the field.
Since:

8.6

getDescription
```
public java.lang.String getDescription()
```
Return the description text for the current language.

Returns:
description text
Since:

8.5

getDescription
```
public java.lang.String getDescription(int languageID)
```
Return the description text for the given language.

Parameters:
languageID - description for given language

Returns:
description text
Since:

8.5

isEditable
```
public boolean isEditable()
```
Returns whether this field should be editable when providing some user interface to a user.

Returns:
whether this field should be editable when providing some user interface to a user
Since:

8.0

getValueMode
```
public FieldValueMode getValueMode()
```
Returns the value mode for this field.

Returns:
the value mode for this field
Since:

8.0

getFormula
```
public java.lang.String getFormula()
```
Returns the formula for this field.

Returns:
the formula for this field
Since:

8.0

getInitialValue
```
public java.lang.String getInitialValue()
```
Returns the "Initial Value" of the field. If getUseInitialValue() is true and no other field linking is active for this field, the initial value is used when cataloging (adding) and/or updating records.

Returns:
the "Initial Value" of the field.

getStringEnumIDs
```
public java.util.List<java.lang.Integer> getStringEnumIDs()
                                                   throws InvalidArgumentException
```
Returns for a field of type string enum the list of string enum IDs in sorted order for the current language.

Returns:
list of string enum IDs in sorted order for the current language

Throws:

InvalidArgumentException - in case of a field type mismatch
Since:

8.0

getStringEnumIDs
```
public java.util.List<java.lang.Integer> getStringEnumIDs(int languageID)
                                                   throws InvalidArgumentException
```
Returns for a field of type string enum the list of string enum IDs in sorted order for the specified language.

Parameters:
languageID - language ID to get the sorted string enum IDs for

Returns:
list of string enum IDs in sorted order for the specified language

Throws:

InvalidArgumentException - in case of a field type mismatch
Since:

8.0

getStringEnumName
```
public java.lang.String getStringEnumName(int enumID)
                                   throws InvalidArgumentException
```
Returns the textual string enum representation for the current language.

Parameters:
enumID - ID of the enum to get the textual representation for

Returns:
textual string enum representation for the current language

Throws:

InvalidArgumentException - in case of an invalid ID
Since:

8.0

getStringEnumName
```
public java.lang.String getStringEnumName(int enumID,
                                 int languageID)
                                   throws InvalidArgumentException
```
Returns the textual string enum representation for the specified language.

Parameters:
enumID - ID of the enum to get the textual representation for
languageID - ID of the wanted language

Returns:
textual string enum representation for the specified language

Throws:

InvalidArgumentException - in case of an invalid ID
Since:

8.0

getStringEnumDescription
```
public java.lang.String getStringEnumDescription(int enumID)
                                          throws InvalidArgumentException
```
Returns the textual string enum description for the current language.

Parameters:
enumID - ID of the enum to get the description for

Returns:
description for the current language or null if not set

Throws:

InvalidArgumentException - in case of an invalid ID
Since:

9.0

getStringEnumDescription
```
public java.lang.String getStringEnumDescription(int enumID,
                                        int languageID)
                                          throws InvalidArgumentException
```
Returns the textual string enum description for the specified language.

Parameters:
enumID - ID of the enum to get the description for
languageID - ID of the wanted language

Returns:
description for the specified language or null if not set

Throws:

InvalidArgumentException - in case of an invalid ID
Since:

9.0

getLayout
```
public Layout getLayout()
```
Returns the layout that created this field definition.

Returns:
layout that created this field definition
Since:

8.0

getCumulusSession
```
public CumulusSession getCumulusSession()
```
Returns the current CumulusSession object.

Returns:
the current CumulusSession object.

getUseFieldLinkingForAdding
```
public boolean getUseFieldLinkingForAdding()
```
Returns whether this field should be linked to filters when adding records.

Returns:
whether this field should be linked to filters when adding records
Since:

8.0

getFieldLinkingForAddingUseAllInputValues
```
public boolean getFieldLinkingForAddingUseAllInputValues()
```
Returns whether this field should be linked to all filter values when adding records. This also requires getUseFieldLinkingForAdding().

Returns:
whether this field should be linked to all filter values when adding records
Since:

8.0

getUseFieldLinkingForUpdating
```
public boolean getUseFieldLinkingForUpdating()
```
Returns whether this field should be linked to filters when updating records.

Returns:
whether this field should be linked to filters when updating records
Since:

8.0

getFieldLinkingForUpdatingUseAllInputValues
```
public boolean getFieldLinkingForUpdatingUseAllInputValues()
```
Returns whether this field should be linked to all filter values when updating records. This also requires getUseFieldLinkingForUpdating().

Returns:
whether this field should be linked to all filter values when updating records
Since:

8.0

getUseFieldLinkingForSaving
```
public boolean getUseFieldLinkingForSaving()
```
Returns whether this field should be linked to filters when saving records.

Returns:
whether this field should be linked to filters when saving records
Since:

8.0

getFieldLinkingUseAllMatchingFields
```
public boolean getFieldLinkingUseAllMatchingFields()
```
Returns whether all newly installed filters should be automatically linked to this field.

Returns:
whether all newly installed filters should be automatically linked to this field
Since:

8.0

equals
```
public boolean equals(java.lang.Object o)
```
Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

getValueTableName
```
public java.lang.String getValueTableName()
```
Returns for a field definition of type table the internal table name of the sub table.

Returns:
internal table name of the sub table
Since:

8.0

getUseInitialValue
```
public boolean getUseInitialValue()
```
Returns the "Use Initial Value" state of the field. If true and no other field linking is active for this field, the value defined under getInitialValue() is taken when adding and/or updating records. Note: If the FieldDefinition object is taken from the Categories table, this method is not available for the following basic category fields:
Returns:
the "Use Initial Value" state of the field.

getAdditionalFieldProperties
```
public JPack getAdditionalFieldProperties()
```
Returns the pack that provides the additional field properties.

Returns:
pack that provides the additional field properties
Since:

7.5.1

toString
```
public java.lang.String toString()
```
Returns this fields name.

Overrides:

toString in class java.lang.Object

Returns:
field name

getMultipleLanguagesFieldType
```
public MultipleLanguagesFieldType getMultipleLanguagesFieldType()
```
Returns the multi language field type.

Returns:
multi language field type
Since:

8.5

getMultipleLanguagesFieldLanguage
```
public int getMultipleLanguagesFieldLanguage()
```
Returns for a multi language field the fields content language.

Returns:
fields content language or LanguageManager.LANGUAGE_NONE if this is not a multi language field
Since:

8.5

getMultipleLanguagesMappedFieldGUID

public GUID getMultipleLanguagesMappedFieldGUID()

Returns for a multi language field the mapped field GUID. This results in three scenarios:

MultipleLanguagesFieldType	GUID
NO_MULTIPLE_LANGUAGE	GUID of this field
BASE_FIELD	virtual field GUID representing this field in the specified base language
CHILD_FIELD	field GUID of the base field of this child language field

Returns:: mapped GUID depending from this multiple languages field type
Since:: 8.5

getMultipleLanguagesBaseFieldGUID
```
public GUID getMultipleLanguagesBaseFieldGUID()
```
Returns for a multi language field the base field GUID. This results in three scenarios:

MultipleLanguagesFieldType GUID

NO_MULTIPLE_LANGUAGE GUID of this field

BASE_FIELD GUID of this field

CHILD_FIELD field GUID of the base field of this child language field

Returns:
base GUID depending from this multiple languages field type
Since:

8.6

MultipleLanguagesFieldType	GUID
NO_MULTIPLE_LANGUAGE	GUID of this field
BASE_FIELD	GUID of this field
CHILD_FIELD	field GUID of the base field of this child language field

getAllVocabulariesItemCollection
```
public ItemCollection getAllVocabulariesItemCollection()
```
Returns an ItemCollection containing all items of the $Vocabulary catalog. This collection can't be used to search for items. Instead it can be used to access all vocabulary items.

Returns:
ItemCollection containing all items of the $Vocabulary catalog
Since:

10.0.2

getVocabularyItemCollection
```
public ItemCollection getVocabularyItemCollection()
```
Returns an empty ItemCollection of the $Vocabulary catalog that has set the defined query (see getVocabularyQuery()) as filter.

Returns:
ItemCollection that is empty
Since:

10.0.2

getRestrictVocabularyItems
```
public boolean getRestrictVocabularyItems()
```
Returns whether this vocabulary field is restricted.

Returns:
true if this field is restricted
Since:

10.0.2

getVocabularyQuery
```
public java.lang.String getVocabularyQuery()
```
Returns the query string defined for the field of value interpretation FieldTypes.VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_MULTIPLE_VALUES or FieldTypes.VALUE_INTERPRETATION_STRING_ENUM_VOCABULARY_SINGLE_VALUE.

Returns:
the query string
Since:

10.0.2

getSortIndexLanguages
```
public java.util.Set<java.lang.Integer> getSortIndexLanguages()
```
Returns for a field of type string a set of language IDs with specific sorting.

Returns:
set of specific sorted languages
Since:

11.1.3

validate
```
public java.lang.String validate(int indexType)
```
Validates the given index of this field and returns an error message. Unstable API! Do not use.

Parameters:
indexType - index to validate

Returns:
error message describing found problems in the specified index of this field.
Since:

9.1

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class FieldDefinition

Field Summary

Fields inherited from interface com.canto.cumulus.FieldTypes

Method Summary

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

Methods inherited from class java.lang.Object

Method Detail

getFieldUID

getCanonicalFieldUID

getCanonicalFieldReference

getFieldReference

getShortID

getFieldType

getValueInterpretation

getIndexing

getFlags

isSortIndexed

isContentIndexed

isContentIndexedNoWordBreak

isWordIndexed

isMandatory

isVisibleInSortPopup

isVisibleInFindWindow

useRegionalSettings

getName

getName

getName

getDescription

getDescription

isEditable

getValueMode

getFormula

getInitialValue

getStringEnumIDs

getStringEnumIDs

getStringEnumName

getStringEnumName

getStringEnumDescription

getStringEnumDescription

getLayout

getCumulusSession

getUseFieldLinkingForAdding

getFieldLinkingForAddingUseAllInputValues

getUseFieldLinkingForUpdating

getFieldLinkingForUpdatingUseAllInputValues

getUseFieldLinkingForSaving

getFieldLinkingUseAllMatchingFields

equals

hashCode

getValueTableName

getUseInitialValue

getAdditionalFieldProperties

toString

getMultipleLanguagesFieldType

getMultipleLanguagesFieldLanguage

getMultipleLanguagesMappedFieldGUID

getMultipleLanguagesBaseFieldGUID

getAllVocabulariesItemCollection

getVocabularyItemCollection

getRestrictVocabularyItems

getVocabularyQuery

getSortIndexLanguages

validate