CatalogField (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.CatalogField

```
public class CatalogField
extends BaseManager
```
This class manages the settings of a single record or category field.

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE`
`static int`	`DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE`
`static int`	`DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE`
`static int`	`FIELD_VALUE_MODE_DYNAMIC_VALUE`
`static int`	`FIELD_VALUE_MODE_USER_VALUE`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`CatalogField`	`addMultipleLanguagesLanguage(int languageID)` Adds the specified language to the multiple languages field bundle.
`FieldLinkingList`	`getAdditionalFieldLinkingList()` Returns the list of fields that are additionally available for the field linking for this field.
`boolean`	`getAutoExtendMatchingFieldList()` Returns whether the field linking should automatically include newly found modules.
`int`	`getBuildupProgressIndexKind()` Returns the index kind of the progress of the index currently created in the background.
`int`	`getBuildupProgressRemainingItems()` Returns the remaining items of the index currently created in the background.
`int`	`getBuildupProgressTotalItems()` Returns the total item count of the index currently created in the background.
`GUID`	`getCanonicalGUID()` This returns the GUID that can be used when referencing this field in external structures like record view sets or print templates.
`CatalogFieldEnumListSort`	`getCatalogFieldEnumListSort()` Returns the manager that holds the sort information for string enum values.
`CatalogFieldEnumListValueContainer`	`getCatalogFieldEnumListValueContainer()` Returns for an enum field the list of enum entries.
`CatalogFieldList`	`getCatalogFieldList()` Returns the `CatalogFieldList` instance this field is contained in.
`CatalogFieldValidatorConfigurationList`	`getCatalogFieldValidatorConfigurationList()` Returns the list of validator configurations for this field.
`boolean`	`getClearWhenUpdating()` Returns whether this field should be cleared before being updated.
`java.lang.String`	`getDescription(int languageID)` Returns the description of this field for the given language.
`int`	`getDynamicFieldValueErrorMode()` Returns the error handling mode if the dynamic function fails.
`java.lang.String`	`getDynamicFieldValueFormula()` Returns the function for the dynamic content creation.
`java.lang.String`	`getFallbackValue()` Returns the fallback value that should be used if a dynamic field fails to execute the stored function.
`CatalogFieldList`	`getFieldList()` Returns the list of sub-table fields for this field.
`boolean`	`getFieldNameIsEditable()` Returns whether this fields name is editable.
`int`	`getFieldType()` Returns the field type.
`int`	`getFieldValueMode()` Returns the mode for this fields values.
`WeakFieldReferenceList`	`getFormulaUpdateRestrictedFieldList()` Returns the list of fields which determine whether this formula field will be updated.
`GUID`	`getGUID()` Returns the GUID for this field.
`int`	`getIndexKind()` Returns the indexing configuration.
`int`	`getIndexKindBuildup()` Returns the indexing configuration for enabled indices which are still created in the background.
`java.lang.String`	`getInitialValue()` Returns the initial value for new records.
`boolean`	`getIsSearchable()` Returns whether this field should be shown in the list of searchable fields in the Find Window.
`FieldLinkingList`	`getMatchingFieldLinkingList()` Returns the list of fields that are automatically available for the field linking for this field.
`GUID`	`getMultipleLanguagesBaseFieldGUID()` Returns the GUID of the multiple languages base field for a multiple languages child field.
`java.util.Map<java.lang.Integer,GUID>`	`getMultipleLanguagesChildren()` Returns a map of languages to field UIDs for all multiple languages children of the multiple languages field bundle.
`int`	`getMultipleLanguagesFieldLanguage()` Returns the language for a multiple languages field.
`MultipleLanguagesFieldType`	`getMultipleLanguagesFieldType()` Returns the multiple languages field type for this field.
`java.lang.String`	`getName(int languageID)` Returns the name of this field for the given language.
`JPack`	`getPack()` Saves all changes back into the pack and returns that pack.
`int`	`getPictureSizeLimit()` Returns the maximum size for this `picture` field if `isLimitPictureSize()` is `true`.
`boolean`	`getReadAllWhenAdding()` Returns whether all found field values are linked back into the field when cataloging or only the first one.
`boolean`	`getReadAllWhenUpdating()` Returns whether all found field values are linked back into the field when updating or only the first one.
`boolean`	`getRestrictVocabularyItems()` Returns whether this vocabulary field is restricted.
`int`	`getShortID()` Returns the short ID of this field.
`java.lang.String`	`getTableName()` Returns the table name of this field for a field of type `FieldTypes.FieldTypeTable`.
`boolean`	`getUseInitialValue()` Returns whether this field should have a initial value.
`RestrictionsList`	`getUserEditRestrictionsList()` Returns the list of roles and users that are allowed to edit this field if `isUserEditRestricted()`.
`boolean`	`getUseRegionalSettings()` Returns whether this field value should be shown using the regional setting.
`RestrictionsList`	`getUserViewRestrictionsList()` Returns the list of roles and users that are allowed to view this field if `isUserVisibilityRestricted()`.
`int`	`getValueInterpretation()` Returns the value interpretation of this field.
`java.lang.String`	`getVocabularyFilterQuery()` Return the vocabulary filter query.
`boolean`	`getWhenAdding()` Returns whether this field should be linked when cataloging.
`boolean`	`getWhenSaving()` Returns whether this field should be linked when saving.
`boolean`	`getWhenUpdating()` Returns whether this field should be linked when updating.
`boolean`	`hideInCatalogViewSortableFieldlist()` Returns whether this field should be shown in the collection window list of sortable fields.
`void`	`hideInCatalogViewSortableFieldlist(boolean value)` Sets whether this field should be shown in the collection window list of sortable fields.
`boolean`	`isAssetUsageEnabledForLogging(AssetUsage assetUsage)` Returns whether the given asset usage is enabled for logging.
`boolean`	`isAssetUsageEnabledForLogging(int assetUsageID)` Returns whether the given asset usage is enabled for logging.
`boolean`	`isBuildupProgressContainsIndex()` Returns whether the contains index is currently created in the background.
`boolean`	`isBuildupProgressSortIndex()` Returns whether the sort index is currently created in the background.
`boolean`	`isBuildupProgressWordIndex()` Returns whether the word index is currently created in the background.
`boolean`	`isContainsIndex()` Return whether this field has a contains index.
`boolean`	`isContainsIndexBuildup()` Return whether this field has a contains index that is currently created in the background.
`boolean`	`isContainsIndexSegmented()` Return whether this field uses a segmented index.
`boolean`	`isContainsIndexSolr()` Return whether this field uses a Solr-based index.
`boolean`	`isContainsIndexWithoutWordBreaks()` Return whether this field has a contains IndexNoWordBreaks.
`boolean`	`isDeletable()` Returns whether this field is deletable.
`boolean`	`isFormulaUpdatingRestricted()` Returns whether this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save.
`boolean`	`isIndexedLanguage(int languageID)` Returns whether the given language has its own language sort index.
`boolean`	`isLimitPictureSize()` Returns whether this `picture` field should limit the size of stored images.
`boolean`	`isMandatory()` Returns whether this field is mandatory.
`boolean`	`isMultipleValuesStringEnum()` Returns whether this field is a multiple values string enum field.
`boolean`	`isReadOnly()` Returns whether this fields settings are read only.
`boolean`	`isSortedIndex()` Return whether this field has a sort index.
`boolean`	`isSortedIndexBuildup()` Return whether this field has a sort index that is currently created in the background.
`boolean`	`isUserEditable()` Returns whether this field is user editable.
`boolean`	`isUserEditRestricted()` Returns whether the user editability is restricted to a group of users or roles.
`boolean`	`isUserVisibilityRestricted()` Returns whether the user visibility is restricted to a group of users or roles.
`boolean`	`isWordIndex()` Return whether this field has a word index.
`boolean`	`isWordIndexBuildup()` Return whether this field has a word index that is currently created in the background.
`void`	`popPack()` This overrides the current state of this class with the state on top of the stack.
`void`	`removeMultipleLanguagesLanguage(int languageID)` Removes the specified language from the multiple languages field bundle.
`void`	`setAssetUsageEnabledForLogging(AssetUsage assetUsage, boolean value)` Sets whether the given asset usage should be enabled for logging.
`void`	`setAssetUsageEnabledForLogging(int assetUsageID, boolean value)` Sets whether the given asset usage should be enabled for logging.
`void`	`setAutoExtendMatchingFieldList(boolean value)` Sets whether the field linking should automatically include newly found modules.
`void`	`setClearWhenUpdating(boolean value)` Configures whether this field should be cleared before being updated.
`void`	`setContainsIndex(boolean isIndexed)` Sets whether this field should have a contains index.
`void`	`setContainsIndexSegmented(boolean isSegmentedIndex)` Sets whether this field should use a segmented index.
`void`	`setContainsIndexSolr(boolean isSolrIndex)` Sets whether this field should use a segmented index.
`void`	`setContainsIndexWithoutWordBreaks(boolean isIndexWithoutWordBreaks)` Sets whether this field should have a contains IndexNoWordBreaks.
`void`	`setDescription(int languageID, java.lang.String value)` Sets the field description for the given language.
`void`	`setDynamicFieldValueErrorMode(int mode)` Configures the error handling mode if the dynamic function fails.
`void`	`setDynamicFieldValueFormula(java.lang.String text)` Sets a new function for the dynamic content creation.
`void`	`setFallbackValue(java.lang.String value)` Sets the fallback value that should be used if a dynamic field fails to execute the stored function.
`void`	`setFieldNameIsEditable(boolean value)` Sets whether this fields name is editable.
`void`	`setFieldValueMode(int mode)` Sets the mode for this fields values.
`void`	`setFormulaUpdatingRestricted(boolean value)` Configures whether this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save.
`void`	`setIndexedLanguage(int languageID, boolean value)` Sets whether the given language should have its own sort index.
`void`	`setInitialValue(java.lang.String value)` Sets the initial value for this field.
`void`	`setLimitPictureSize(boolean value)` Configures whether this `picture` field should limit the size of stored images.
`void`	`setMandatory(boolean value)` Sets whether this field should be mandatory.
`void`	`setModified()` Marks this field as modified.
`void`	`setMultipleLanguagesBaseField(int baseFieldLanguage)` Enables or disables a multiple languages field bundle by providing a language to assume for this field which is configured as the multiple languages base field.
`void`	`setMultipleLanguagesBaseFieldLanguage(int language)` Configures the language to assume for a multiple languages base field.
`void`	`setMultipleValuesStringEnum(boolean val)` Sets this field as a multiple values string enum field.
`void`	`setName(int languageID, java.lang.String value)` Sets the field name for the given language.
`void`	`setPictureSizeLimit(int value)` Configures the maximum size for this `picture` field if `isLimitPictureSize()` is `true`.
`void`	`setReadAllWhenAdding(boolean value)` Configures whether all found field values are linked back into the field when cataloging or only the first one.
`void`	`setReadAllWhenUpdating(boolean value)` Configures whether all found field values are linked back into the field when updating or only the first one.
`void`	`setRestrictVocabularyItems(boolean restrictVocabularyItems)` Sets whether this vocabulary field is restricted.
`void`	`setSearchable(boolean value)` Sets whether this field should be shown in the Find Window as a field to search for.
`void`	`setSortedIndex(boolean isIndexed)` Sets whether this field should have a sort index.
`void`	`setUseInitialValue(boolean value)` Sets whether this field should have a initial value.
`void`	`setUserEditable(boolean value)` Configures whether this field is user editable.
`void`	`setUserEditRestricted(boolean value)` Sets whether the user editability is restricted to a group of users or roles.
`void`	`setUseRegionalSettings(boolean useRegionalSettings)` Sets whether this field value should be shown using the regional setting.
`void`	`setUserVisibilityRestricted(boolean value)` Sets whether the user visibility is restricted to a group of users or roles.
`void`	`setValueInterpretation(int value)` Sets the value interpretation of this field.
`void`	`setVocabularyFilterQuery(java.lang.String vocabularyFilterQuery)` Sets the vocabulary filter query.
`void`	`setWhenAdding(boolean value)` Sets whether this field should be linked when cataloging.
`void`	`setWhenSaving(boolean value)` Configures whether this field should be linked when saving.
`void`	`setWhenUpdating(boolean value)` Configures whether this field should be linked when updating.
`void`	`setWordIndex(boolean isIndexed)` Sets whether this field should have a word index.
`void`	`updateMultipleLanguagesChildrenFieldNames()` Recreates all children field names from base field names again.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, isShared, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

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

- Field Detail
  - FIELD_VALUE_MODE_USER_VALUE
```
public static final int FIELD_VALUE_MODE_USER_VALUE
```
    See Also:
    Constant Field Values
  - FIELD_VALUE_MODE_DYNAMIC_VALUE
```
public static final int FIELD_VALUE_MODE_DYNAMIC_VALUE
```
    See Also:
    Constant Field Values
  - DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE
```
public static final int DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE
```
    See Also:
    Constant Field Values
  - DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE
```
public static final int DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE
```
    See Also:
    Constant Field Values
  - DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE
```
public static final int DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE
```
    See Also:
    Constant Field Values
- Method Detail
  - getGUID
```
public GUID getGUID()
```
    Returns the GUID for this field.
    
    Returns:
    field GUID
  - getCatalogFieldList
```
public CatalogFieldList getCatalogFieldList()
```
    Returns the CatalogFieldList instance this field is contained in.
    
    Returns:
    CatalogFieldList instance this field is contained in
    Since:
    
    9.0
  - getShortID
```
public int getShortID()
```
    Returns the short ID of this field.
    
    Returns:
    field short ID
  - getName
```
public java.lang.String getName(int languageID)
```
    Returns the name of this field for the given language.
    
    Parameters:
    languageID - the language to get the field name for
    
    Returns:
    field name
  - setName
```
public void setName(int languageID,
           java.lang.String value)
```
    Sets the field name for the given language.
    
    Parameters:
    languageID - the language to set the field name for
    value - the new field name, use null to clear the value
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description of this field for the given language.
    
    Parameters:
    languageID - the language to get the field description for
    
    Returns:
    field description or null if not yet configured
    Since:
    
    8.5
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String value)
```
    Sets the field description for the given language.
    
    Parameters:
    languageID - the language to set the field description for
    value - the new field description
    Since:
    
    8.5
  - isDeletable
```
public boolean isDeletable()
```
    Returns whether this field is deletable.
    
    Returns:
    true if this field is deletable
  - getIndexKind
```
public int getIndexKind()
```
    Returns the indexing configuration. Usually it's a better idea to call isContainsIndex(), isContainsIndexWithoutWordBreaks(), isSortedIndex() or isWordIndex() directly.
    
    Returns:
    indexing configuration
  - getIndexKindBuildup
```
public int getIndexKindBuildup()
```
    Returns the indexing configuration for enabled indices which are still created in the background.
    
    Returns:
    indexing configuration for background index creation
    Since:
    
    9.0
  - getBuildupProgressRemainingItems
```
public int getBuildupProgressRemainingItems()
```
    Returns the remaining items of the index currently created in the background.
    
    Returns:
    remaining items of the index currently created in the background
    Since:
    
    9.0
  - getBuildupProgressTotalItems
```
public int getBuildupProgressTotalItems()
```
    Returns the total item count of the index currently created in the background.
    
    Returns:
    total item count of the index currently created in the background
    Since:
    
    9.0
  - getBuildupProgressIndexKind
```
public int getBuildupProgressIndexKind()
```
    Returns the index kind of the progress of the index currently created in the background.
    
    Returns:
    index kind of the progress of the index currently created in the background
    Since:
    
    9.0
  - isBuildupProgressSortIndex
```
public boolean isBuildupProgressSortIndex()
```
    Returns whether the sort index is currently created in the background.
    
    Returns:
    whether the sort index is currently created in the background
    Since:
    
    9.0
  - isBuildupProgressContainsIndex
```
public boolean isBuildupProgressContainsIndex()
```
    Returns whether the contains index is currently created in the background.
    
    Returns:
    whether the contains index is currently created in the background
    Since:
    
    9.0
  - isBuildupProgressWordIndex
```
public boolean isBuildupProgressWordIndex()
```
    Returns whether the word index is currently created in the background.
    
    Returns:
    whether the word index is currently created in the background
    Since:
    
    9.0
  - isMultipleValuesStringEnum
```
public boolean isMultipleValuesStringEnum()
```
    Returns whether this field is a multiple values string enum field.
    
    Returns:
    true if this field is a multiple values string enum field
  - setMultipleValuesStringEnum
```
public void setMultipleValuesStringEnum(boolean val)
```
    Sets this field as a multiple values string enum field. You need to check yourself whether this makes any sense at all.
    
    Parameters:
    val - set to true to make this field a multiple values string enum field
  - isSortedIndex
```
public boolean isSortedIndex()
```
    Return whether this field has a sort index.
    
    Returns:
    true if this field has a sort index
  - isSortedIndexBuildup
```
public boolean isSortedIndexBuildup()
```
    Return whether this field has a sort index that is currently created in the background.
    
    Returns:
    true if this field has a sort index that is currently created in the background
    Since:
    
    9.0
  - setSortedIndex
```
public void setSortedIndex(boolean isIndexed)
```
    Sets whether this field should have a sort index.
    
    Parameters:
    isIndexed - set to true to enable a sort index
  - isWordIndex
```
public boolean isWordIndex()
```
    Return whether this field has a word index.
    
    Returns:
    true if this field has a word index
  - isWordIndexBuildup
```
public boolean isWordIndexBuildup()
```
    Return whether this field has a word index that is currently created in the background.
    
    Returns:
    true if this field has a word index that is currently created in the background
    Since:
    
    9.0
  - setWordIndex
```
public void setWordIndex(boolean isIndexed)
```
    Sets whether this field should have a word index.
    
    Parameters:
    isIndexed - set to true to enable a word index
  - isContainsIndex
```
public boolean isContainsIndex()
```
    Return whether this field has a contains index.
    
    Returns:
    true if this field has a contains index
  - isContainsIndexBuildup
```
public boolean isContainsIndexBuildup()
```
    Return whether this field has a contains index that is currently created in the background.
    
    Returns:
    true if this field has a contains index that is currently created in the background
    Since:
    
    9.0
  - setContainsIndex
```
public void setContainsIndex(boolean isIndexed)
```
    Sets whether this field should have a contains index.
    
    Parameters:
    isIndexed - set to true to enable a contains index
  - isContainsIndexWithoutWordBreaks
```
public boolean isContainsIndexWithoutWordBreaks()
```
    Return whether this field has a contains IndexNoWordBreaks.
    
    Returns:
    true if this field has a contains IndexNoWordBreaks
    Since:
    
    8.1
  - setContainsIndexWithoutWordBreaks
```
public void setContainsIndexWithoutWordBreaks(boolean isIndexWithoutWordBreaks)
```
    Sets whether this field should have a contains IndexNoWordBreaks.
    
    Parameters:
    isIndexWithoutWordBreaks - set to true to enable a contains IndexNoWordBreaks
    Since:
    
    8.1
  - isContainsIndexSegmented
```
public boolean isContainsIndexSegmented()
```
    Return whether this field uses a segmented index.
    
    Returns:
    true if this field uses a segmented index
    Since:
    
    9.0
  - setContainsIndexSegmented
```
public void setContainsIndexSegmented(boolean isSegmentedIndex)
```
    Sets whether this field should use a segmented index.
    
    Parameters:
    isSegmentedIndex - set to true to enable a segmented index
    Since:
    
    9.0
  - isContainsIndexSolr
```
public boolean isContainsIndexSolr()
```
    Return whether this field uses a Solr-based index.
    
    Returns:
    true if this field uses a Solr-based index
    Since:
    
    11.0
  - setContainsIndexSolr
```
public void setContainsIndexSolr(boolean isSolrIndex)
```
    Sets whether this field should use a segmented index.
    
    Parameters:
    isSolrIndex - set to true to enable a Solr-based index
    Since:
    
    11.0
  - isIndexedLanguage
```
public boolean isIndexedLanguage(int languageID)
```
    Returns whether the given language has its own language sort index.
    
    Parameters:
    languageID - the language ID
    
    Returns:
    true if the given language has its own sort index
  - setIndexedLanguage
```
public void setIndexedLanguage(int languageID,
                      boolean value)
```
    Sets whether the given language should have its own sort index.
    
    Parameters:
    languageID - the language ID
    value - set to true to enable the sort index for the given language
  - isAssetUsageEnabledForLogging
```
public boolean isAssetUsageEnabledForLogging(AssetUsage assetUsage)
```
    Returns whether the given asset usage is enabled for logging.
    
    Parameters:
    assetUsage - the asset usage
    
    Returns:
    true if the given asset usage is enabled for logging
    Since:
    
    8.0
  - isAssetUsageEnabledForLogging
```
public boolean isAssetUsageEnabledForLogging(int assetUsageID)
```
    Returns whether the given asset usage is enabled for logging.
    
    Parameters:
    assetUsageID - the asset usage
    
    Returns:
    true if the given asset usage is enabled for logging
    Since:
    
    10.2.1
  - setAssetUsageEnabledForLogging
```
public void setAssetUsageEnabledForLogging(AssetUsage assetUsage,
                                  boolean value)
```
    Sets whether the given asset usage should be enabled for logging.
    
    Parameters:
    assetUsage - the asset usage
    value - set to true to enable logging of the given asset usage
    Since:
    
    8.0
  - setAssetUsageEnabledForLogging
```
public void setAssetUsageEnabledForLogging(int assetUsageID,
                                  boolean value)
```
    Sets whether the given asset usage should be enabled for logging.
    
    Parameters:
    assetUsageID - the asset usage
    value - set to true to enable logging of the given asset usage
    Since:
    
    10.2.1
  - getFieldType
```
public int getFieldType()
```
    Returns the field type.
    
    Returns:
    field type
  - getFieldNameIsEditable
```
public boolean getFieldNameIsEditable()
```
    Returns whether this fields name is editable.
    
    Returns:
    true if this fields name is editable
  - setFieldNameIsEditable
```
public void setFieldNameIsEditable(boolean value)
```
    Sets whether this fields name is editable.
    
    Parameters:
    value - set to true if this fields name is editable
  - isUserEditable
```
public boolean isUserEditable()
```
    Returns whether this field is user editable.
    
    Returns:
    true if this field is user editable
  - setUserEditable
```
public void setUserEditable(boolean value)
```
    Configures whether this field is user editable.
    
    Parameters:
    value - set to true if this field should be user editable
  - isMandatory
```
public boolean isMandatory()
```
    Returns whether this field is mandatory.
    
    Returns:
    true if this field is mandatory
  - setMandatory
```
public void setMandatory(boolean value)
```
    Sets whether this field should be mandatory.
    
    Parameters:
    value - set to true if this field should be mandatory
  - getUseInitialValue
```
public boolean getUseInitialValue()
```
    Returns whether this field should have a initial value.
    
    Returns:
    true if this field should have a initial value
  - setUseInitialValue
```
public void setUseInitialValue(boolean value)
```
    Sets whether this field should have a initial value.
    
    Parameters:
    value - set to true if this field should have a initial value
    See Also:
    setInitialValue(String)
  - getWhenAdding
```
public boolean getWhenAdding()
```
    Returns whether this field should be linked when cataloging.
    
    Returns:
    true if this field should be linked when cataloging
  - setWhenAdding
```
public void setWhenAdding(boolean value)
```
    Sets whether this field should be linked when cataloging.
    
    Parameters:
    value - set to true if this field should be linked when cataloging
  - getReadAllWhenAdding
```
public boolean getReadAllWhenAdding()
```
    Returns whether all found field values are linked back into the field when cataloging or only the first one.
    
    Returns:
    true if all found field values are linked back into the field
  - setReadAllWhenAdding
```
public void setReadAllWhenAdding(boolean value)
```
    Configures whether all found field values are linked back into the field when cataloging or only the first one.
    
    Parameters:
    value - set to true if all found field values should be linked back into the field
  - getWhenUpdating
```
public boolean getWhenUpdating()
```
    Returns whether this field should be linked when updating.
    
    Returns:
    true if this field should be linked when updating
  - getClearWhenUpdating
```
public boolean getClearWhenUpdating()
```
    Returns whether this field should be cleared before being updated.
    
    Returns:
    true if this field should be cleared before being updated
    Since:
    
    8.0
  - setClearWhenUpdating
```
public void setClearWhenUpdating(boolean value)
```
    Configures whether this field should be cleared before being updated.
    
    Parameters:
    value - true if this field should be cleared before being updated
    Since:
    
    8.0
  - setWhenUpdating
```
public void setWhenUpdating(boolean value)
```
    Configures whether this field should be linked when updating.
    
    Parameters:
    value - set to true if this field should be linked when updating
  - getReadAllWhenUpdating
```
public boolean getReadAllWhenUpdating()
```
    Returns whether all found field values are linked back into the field when updating or only the first one.
    
    Returns:
    true if all found field values are linked back into the field
  - setReadAllWhenUpdating
```
public void setReadAllWhenUpdating(boolean value)
```
    Configures whether all found field values are linked back into the field when updating or only the first one.
    
    Parameters:
    value - set to true if all found field values should be linked back into the field
  - getWhenSaving
```
public boolean getWhenSaving()
```
    Returns whether this field should be linked when saving.
    
    Returns:
    true if this field should be linked when saving
  - setWhenSaving
```
public void setWhenSaving(boolean value)
```
    Configures whether this field should be linked when saving.
    
    Parameters:
    value - set to true if this field should be linked when saving
  - getAutoExtendMatchingFieldList
```
public boolean getAutoExtendMatchingFieldList()
```
    Returns whether the field linking should automatically include newly found modules.
    
    Returns:
    true if the field linking should automatically include newly found modules
  - setAutoExtendMatchingFieldList
```
public void setAutoExtendMatchingFieldList(boolean value)
```
    Sets whether the field linking should automatically include newly found modules.
    
    Parameters:
    value - set to true if the field linking should automatically include newly found modules
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns whether this fields settings are read only.
    
    Returns:
    true if this fields settings are read only
    Since:
    
    7.5
  - getInitialValue
```
public java.lang.String getInitialValue()
```
    Returns the initial value for new records.
    
    Returns:
    initial value
  - setInitialValue
```
public void setInitialValue(java.lang.String value)
```
    Sets the initial value for this field.
    
    Parameters:
    value - new initial value
  - getFallbackValue
```
public java.lang.String getFallbackValue()
```
    Returns the fallback value that should be used if a dynamic field fails to execute the stored function.
    
    Returns:
    the fallback value being used
  - setFallbackValue
```
public void setFallbackValue(java.lang.String value)
```
    Sets the fallback value that should be used if a dynamic field fails to execute the stored function.
    
    Parameters:
    value - new fallback value
  - getValueInterpretation
```
public int getValueInterpretation()
```
    Returns the value interpretation of this field.
    
    Returns:
    value interpretation
  - setValueInterpretation
```
public void setValueInterpretation(int value)
```
    Sets the value interpretation of this field.
    
    Parameters:
    value - new value interpretation
  - getCatalogFieldEnumListSort
```
public CatalogFieldEnumListSort getCatalogFieldEnumListSort()
```
    Returns the manager that holds the sort information for string enum values.
    
    Returns:
    manager that holds the sort information for string enum values
  - getCatalogFieldEnumListValueContainer
```
public CatalogFieldEnumListValueContainer getCatalogFieldEnumListValueContainer()
```
    Returns for an enum field the list of enum entries.
    
    Returns:
    list of enum entries
  - getMatchingFieldLinkingList
```
public FieldLinkingList getMatchingFieldLinkingList()
```
    Returns the list of fields that are automatically available for the field linking for this field.
    
    Returns:
    list of fields that are automatically available for the field linking for this field
  - getAdditionalFieldLinkingList
```
public FieldLinkingList getAdditionalFieldLinkingList()
```
    Returns the list of fields that are additionally available for the field linking for this field.
    
    Returns:
    list of fields that are additionally available for the field linking for this field
  - setModified
```
public void setModified()
```
    Marks this field as modified. Without this flag all changes for this field are skipped by the server when saving the catalog settings.
  - popPack
```
public void popPack()
```
    Description copied from class: BaseManager
    
    This overrides the current state of this class with the state on top of the stack.
    
    Overrides:
    
    popPack in class BaseManager
    
    See Also:
    BaseManager.pushPack()
  - isUserEditRestricted
```
public boolean isUserEditRestricted()
```
    Returns whether the user editability is restricted to a group of users or roles.
    
    Returns:
    true if the user editability is restricted to a group of users or roles
  - setUserEditRestricted
```
public void setUserEditRestricted(boolean value)
```
    Sets whether the user editability is restricted to a group of users or roles.
    
    Parameters:
    value - set to true if the user editability should be restricted to a group of users or roles
  - getPack
```
public JPack getPack()
```
    Description copied from class: BaseManager
    
    Saves all changes back into the pack and returns that pack.
    
    Overrides:
    
    getPack in class BaseManager
    
    Returns:
    the pack containing all changes.
  - getUserEditRestrictionsList
```
public RestrictionsList getUserEditRestrictionsList()
```
    Returns the list of roles and users that are allowed to edit this field if isUserEditRestricted().
    
    Returns:
    list of roles and users that are allowed to edit this field
  - isUserVisibilityRestricted
```
public boolean isUserVisibilityRestricted()
```
    Returns whether the user visibility is restricted to a group of users or roles.
    
    Returns:
    true if the user visibility is restricted to a group of users or roles
    Since:
    
    8.5
  - setUserVisibilityRestricted
```
public void setUserVisibilityRestricted(boolean value)
```
    Sets whether the user visibility is restricted to a group of users or roles.
    
    Parameters:
    value - set to true if the user visibility should be restricted to a group of users or roles
    Since:
    
    8.5
  - getUserViewRestrictionsList
```
public RestrictionsList getUserViewRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this field if isUserVisibilityRestricted().
    
    Returns:
    list of roles and users that are allowed to view this field
    Since:
    
    8.5
  - hideInCatalogViewSortableFieldlist
```
public boolean hideInCatalogViewSortableFieldlist()
```
    Returns whether this field should be shown in the collection window list of sortable fields.
    
    Returns:
    true if this field should not be shown in that list
  - hideInCatalogViewSortableFieldlist
```
public void hideInCatalogViewSortableFieldlist(boolean value)
```
    Sets whether this field should be shown in the collection window list of sortable fields.
    
    Parameters:
    value - set to true if this field should not be shown in that list
  - getIsSearchable
```
public boolean getIsSearchable()
```
    Returns whether this field should be shown in the list of searchable fields in the Find Window.
    
    Returns:
    true if the field should be shown
    Since:
    
    8.0
  - setSearchable
```
public void setSearchable(boolean value)
```
    Sets whether this field should be shown in the Find Window as a field to search for.
    
    Parameters:
    value - set to true if this field should be shown in that list
    Since:
    
    8.0
  - getFieldValueMode
```
public int getFieldValueMode()
```
    Returns the mode for this fields values. Supported modes are FIELD_VALUE_MODE_USER_VALUE and FIELD_VALUE_MODE_DYNAMIC_VALUE. Defaults to FIELD_VALUE_MODE_USER_VALUE.
    
    Returns:
    the mode for this fields values
  - setFieldValueMode
```
public void setFieldValueMode(int mode)
```
    Sets the mode for this fields values. Supported modes are FIELD_VALUE_MODE_USER_VALUE and FIELD_VALUE_MODE_DYNAMIC_VALUE.
    
    Parameters:
    mode - mode for this fields values
  - getDynamicFieldValueErrorMode
```
public int getDynamicFieldValueErrorMode()
```
    Returns the error handling mode if the dynamic function fails. The supported modes are DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE, DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE and DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE. Defaults to DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE.
    
    Returns:
    the error handling mode
  - setDynamicFieldValueErrorMode
```
public void setDynamicFieldValueErrorMode(int mode)
```
    Configures the error handling mode if the dynamic function fails. The supported modes are DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE, DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE and DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE.
    
    Parameters:
    mode - the error handling mode
  - getDynamicFieldValueFormula
```
public java.lang.String getDynamicFieldValueFormula()
```
    Returns the function for the dynamic content creation.
    
    Returns:
    function for the dynamic content creation
  - setDynamicFieldValueFormula
```
public void setDynamicFieldValueFormula(java.lang.String text)
```
    Sets a new function for the dynamic content creation.
    
    Parameters:
    text - new function for the dynamic content creation
  - getFieldList
```
public CatalogFieldList getFieldList()
```
    Returns the list of sub-table fields for this field.
    
    Returns:
    list of sub fields
  - getTableName
```
public java.lang.String getTableName()
```
    Returns the table name of this field for a field of type FieldTypes.FieldTypeTable.
    
    Returns:
    table name or null
    Since:
    
    8.1.2
  - getCatalogFieldValidatorConfigurationList
```
public CatalogFieldValidatorConfigurationList getCatalogFieldValidatorConfigurationList()
```
    Returns the list of validator configurations for this field.
    
    Returns:
    list of validator configurations for this field
    Since:
    
    8.5
  - getMultipleLanguagesFieldType
```
public MultipleLanguagesFieldType getMultipleLanguagesFieldType()
```
    Returns the multiple languages field type for this field.
    
    Returns:
    multiple languages field type for this field
    Since:
    
    8.5
    
    See Also:
    MultipleLanguagesFieldType
  - setMultipleLanguagesBaseField
```
public void setMultipleLanguagesBaseField(int baseFieldLanguage)
```
    Enables or disables a multiple languages field bundle by providing a language to assume for this field which is configured as the multiple languages base field.
    To disable the multiple languages field bundle specify LanguageManager.LANGUAGE_NONE. This removes all child languages from the bundle and configures this field to be a non-multiple-languages field again.
    
    Parameters:
    baseFieldLanguage - language to assume for the base field of a multiple languages field bundle or LanguageManager.LANGUAGE_NONE to disable the multiple languages field bundle
    Since:
    
    8.5
    
    See Also:
    MultipleLanguagesFieldType.BASE_FIELD
  - getMultipleLanguagesFieldLanguage
```
public int getMultipleLanguagesFieldLanguage()
```
    Returns the language for a multiple languages field. This can be called on the base field but also on the child fields.
    
    Returns:
    multiple languages field language
    Since:
    
    8.5
  - setMultipleLanguagesBaseFieldLanguage
```
public void setMultipleLanguagesBaseFieldLanguage(int language)
```
    Configures the language to assume for a multiple languages base field. This fields needs to be a base field already. Must be called on the base field of a multiple languages field bundle.
    
    Parameters:
    language - language to assume for this base field
    Since:
    
    8.5
  - getMultipleLanguagesBaseFieldGUID
```
public GUID getMultipleLanguagesBaseFieldGUID()
```
    Returns the GUID of the multiple languages base field for a multiple languages child field. In any other case the normal field UID is returned.
    
    Returns:
    GUID of the multiple languages base field for a multiple languages child field
    Since:
    
    8.5
  - getCanonicalGUID
```
public GUID getCanonicalGUID()
```
    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
  - addMultipleLanguagesLanguage
```
public CatalogField addMultipleLanguagesLanguage(int languageID)
```
    Adds the specified language to the multiple languages field bundle. If the bundle already contains the specified language the existing field is returned. Must be called on the base field of a multiple languages field bundle.
    
    Parameters:
    languageID - language to add
    
    Returns:
    new created field
    Since:
    
    8.5
  - updateMultipleLanguagesChildrenFieldNames
```
public void updateMultipleLanguagesChildrenFieldNames()
```
    Recreates all children field names from base field names again. Useful to call when changing field names on the base field to apply those changes to all multi language children as well.
    
    Since:
    
    8.5
  - removeMultipleLanguagesLanguage
```
public void removeMultipleLanguagesLanguage(int languageID)
```
    Removes the specified language from the multiple languages field bundle. Must be called on the multiple languages base field.
    
    Parameters:
    languageID - language to remove
    Since:
    
    8.5
  - getMultipleLanguagesChildren
```
public java.util.Map<java.lang.Integer,GUID> getMultipleLanguagesChildren()
```
    Returns a map of languages to field UIDs for all multiple languages children of the multiple languages field bundle.
    
    Returns:
    map pointing with language id to child field UID
    Since:
    
    8.5
  - isFormulaUpdatingRestricted
```
public boolean isFormulaUpdatingRestricted()
```
    Returns whether this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save.
    
    Returns:
    true this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save, otherwise false
    Since:
    
    9.0
  - setFormulaUpdatingRestricted
```
public void setFormulaUpdatingRestricted(boolean value)
```
    Configures whether this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save.
    
    Parameters:
    value - true if this formula field should only be updated if one of the listed dependency fields changed instead of being updated on every item save, otherwise false
    Since:
    
    9.0
  - getFormulaUpdateRestrictedFieldList
```
public WeakFieldReferenceList getFormulaUpdateRestrictedFieldList()
```
    Returns the list of fields which determine whether this formula field will be updated.
    
    Returns:
    list of fields which determine whether this formula field will be updated
    Since:
    
    9.0
  - isLimitPictureSize
```
public boolean isLimitPictureSize()
```
    Returns whether this picture field should limit the size of stored images.
    
    Returns:
    true if this picture field should limit the size of stored images, otherwise false
    Since:
    
    9.0
  - setLimitPictureSize
```
public void setLimitPictureSize(boolean value)
```
    Configures whether this picture field should limit the size of stored images.
    
    Parameters:
    value - true if this picture field should limit the size of stored images, otherwise false
    Since:
    
    9.0
  - getPictureSizeLimit
```
public int getPictureSizeLimit()
```
    Returns the maximum size for this picture field if isLimitPictureSize() is true.
    
    Returns:
    maximum size for this picture field if isLimitPictureSize() is true
    Since:
    
    9.0
  - setPictureSizeLimit
```
public void setPictureSizeLimit(int value)
```
    Configures the maximum size for this picture field if isLimitPictureSize() is true.
    
    Since:
    
    9.0
    
    See Also:
    setLimitPictureSize(boolean)
  - getRestrictVocabularyItems
```
public boolean getRestrictVocabularyItems()
```
    Returns whether this vocabulary field is restricted.
    
    Returns:
    true if this field is restricted
    Since:
    
    10.0.2
  - setRestrictVocabularyItems
```
public void setRestrictVocabularyItems(boolean restrictVocabularyItems)
```
    Sets whether this vocabulary field is restricted.
    
    Parameters:
    restrictVocabularyItems - true if this field is restricted, false if not restricted
    Since:
    
    10.0.2
  - getVocabularyFilterQuery
```
public java.lang.String getVocabularyFilterQuery()
```
    Return the vocabulary filter query.
    
    Returns:
    vocabulary filter query
    Since:
    
    10.0.2
  - setVocabularyFilterQuery
```
public void setVocabularyFilterQuery(java.lang.String vocabularyFilterQuery)
```
    Sets the vocabulary filter query.
    
    Parameters:
    vocabularyFilterQuery - vocabulary filter query
    Since:
    
    10.0.2
  - getUseRegionalSettings
```
public boolean getUseRegionalSettings()
```
    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
  - setUseRegionalSettings
```
public void setUseRegionalSettings(boolean useRegionalSettings)
```
    Sets whether this field value should be shown using the regional setting.
    
    Parameters:
    useRegionalSettings - set to true if this field value should be shown using the regional setting
    Since:
    
    11.1.5

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 CatalogField

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

FIELD_VALUE_MODE_USER_VALUE

FIELD_VALUE_MODE_DYNAMIC_VALUE

DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_LEAVE_OLD_VALUE

DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_CLEAR_VALUE

DYNAMIC_FIELDVALUE_ERROR_MODE_OPTION_USE_FALLBACK_VALUE

Method Detail

getGUID

getCatalogFieldList

getShortID

getName

setName

getDescription

setDescription

isDeletable

getIndexKind

getIndexKindBuildup

getBuildupProgressRemainingItems

getBuildupProgressTotalItems

getBuildupProgressIndexKind

isBuildupProgressSortIndex

isBuildupProgressContainsIndex

isBuildupProgressWordIndex

isMultipleValuesStringEnum

setMultipleValuesStringEnum

isSortedIndex

isSortedIndexBuildup

setSortedIndex

isWordIndex

isWordIndexBuildup

setWordIndex

isContainsIndex

isContainsIndexBuildup

setContainsIndex

isContainsIndexWithoutWordBreaks

setContainsIndexWithoutWordBreaks

isContainsIndexSegmented

setContainsIndexSegmented

isContainsIndexSolr

setContainsIndexSolr

isIndexedLanguage

setIndexedLanguage

isAssetUsageEnabledForLogging

isAssetUsageEnabledForLogging

setAssetUsageEnabledForLogging

setAssetUsageEnabledForLogging

getFieldType

getFieldNameIsEditable

setFieldNameIsEditable

isUserEditable

setUserEditable

isMandatory

setMandatory

getUseInitialValue

setUseInitialValue

getWhenAdding

setWhenAdding

getReadAllWhenAdding

setReadAllWhenAdding

getWhenUpdating

getClearWhenUpdating

setClearWhenUpdating

setWhenUpdating

getReadAllWhenUpdating

setReadAllWhenUpdating

getWhenSaving

setWhenSaving

getAutoExtendMatchingFieldList

setAutoExtendMatchingFieldList

isReadOnly

getInitialValue

setInitialValue