FieldListEntry (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.FieldListEntry

```
public class FieldListEntry
extends java.lang.Object
```
The FieldListEntry object represents an entry of the FieldList object. It contains information about the a field, the module it comes from, its's name, type and GUID, and it's properties.

Since:

1.0

See Also:
FieldList

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowUserToEdit()` Returns whether the field is editable by the user.
`CumulusSession`	`getCumulusSession()` Returns the current `CumulusSession` object.
`java.lang.String`	`getDefaultMasterCategoryName()` Returns the default master category name for the record "Categories" field.
`int`	`getFieldType()` Returns the type of this field.
`GUID`	`getFieldUID()` Returns the field's `GUID`.
`int`	`getIndexKind()` Returns the field's indexing preferences.
`GUID`	`getModuleClassUID()` Returns the module's `GUID`.
`java.lang.String`	`getModuleName()` Returns the module's name using the default language.
`java.lang.String`	`getModuleName(int language)` Returns the module's name.
`java.lang.String`	`getName()` Returns the field's name using the default language.
`java.lang.String`	`getName(int language)` Returns the field's name in the given language.
`java.util.List<java.lang.Integer>`	`getStringEnumIDs()` Return the list of IDs for a `String List` field.
`java.util.List<java.lang.Integer>`	`getStringEnumIDs(int languageID)` Return the list of IDs for a `String List` field.
`java.lang.String`	`getStringEnumName(int enumID)` Returns the string enum name for the given id.
`java.lang.String`	`getStringEnumName(int enumID, int languageID)` Returns the string enum name for the given id and requested language.
`java.util.Set<GUID>`	`getTableFieldUIDs()` In case of a table field this method returns the field UIDs for the sub table fields.
`int`	`getValueInterpretation()` Returns the value interpretation for this field.
`boolean`	`isAtomicField()` Returns true when this field can be used on all tables or false if it's part of a sub-table definition only.
`boolean`	`linkWhenAdding()` Returns the "Linking when Adding Assets" state of the field.
`boolean`	`linkWhenSaving()` Returns the "Linking when Saving to Assets" state of the field.
`boolean`	`linkWhenUpdating()` Returns the "Linking when Updating Assets" state of the field.
`boolean`	`readAllWhenAdding()` Returns the "When Adding Assets Read All" state of the field.
`boolean`	`readAllWhenUpdating()` Returns the "When Updating Assets Read All" state of the field.
`java.lang.String`	`toString()` Returns the field's name.

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

- Method Detail
  - getCumulusSession
```
public CumulusSession getCumulusSession()
```
    Returns the current CumulusSession object.
    
    Returns:
    the current CumulusSession object.
  - getFieldType
```
public int getFieldType()
```
    Returns the type of this field.
    Returns:
    the type of this field. Possible values are:
    
    FieldTypes.FieldTypeString
    
    FieldTypes.FieldTypeBool
    
    FieldTypes.FieldTypeInteger
    
    FieldTypes.FieldTypeDouble
    
    FieldTypes.FieldTypeDate
    
    FieldTypes.FieldTypeBinary
    
    FieldTypes.FieldTypePicture
    
    FieldTypes.FieldTypeEnum
    
    FieldTypes.FieldTypeAudio
    
    FieldTypes.FieldTypeLong
  - allowUserToEdit
```
public boolean allowUserToEdit()
```
    Returns whether the field is editable by the user.
    
    Returns:
    true if the field is editable; false otherwise.
  - getIndexKind
```
public int getIndexKind()
```
    Returns the field's indexing preferences.
    Returns:
    the field's indexing preferences. Possible values are:
    
    Cumulus.IndexKindNotIndexed
    
    Cumulus.IndexKindSortIndexed
    
    Cumulus.IndexKindContentIndexed
    
    Cumulus.IndexKindSortContentIndexed
    
    These values may be combined by using a logical or (operator |).
  - linkWhenAdding
```
public boolean linkWhenAdding()
```
    Returns the "Linking when Adding Assets" state of the field. This indicates whether field linking should occur when an asset is added to the catalog.
    
    Returns:
    the "Linking when Adding Assets" state of the field.
  - readAllWhenAdding
```
public boolean readAllWhenAdding()
```
    Returns the "When Adding Assets Read All" state of the field. If linkWhenAdding() is true, the returned value determines whether the field is filled from all linked fields, or only from the first one.
    
    Returns:
    the "When Adding Assets Read All" state of the field.
  - linkWhenUpdating
```
public boolean linkWhenUpdating()
```
    Returns the "Linking when Updating Assets" state of the field. This indicates whether field linking should occur when an asset is updated.
    
    Returns:
    the "Linking when Updating Assets" state of the field.
  - readAllWhenUpdating
```
public boolean readAllWhenUpdating()
```
    Returns the "When Updating Assets Read All" state of the field. If linkWhenUpdating() is true, the returned value determines whether the field is filled from all linked fields, or only from the first one.
    
    Returns:
    the "When Updating Assets Read All" state of the field.
  - linkWhenSaving
```
public boolean linkWhenSaving()
```
    Returns the "Linking when Saving to Assets" state of the field. Note: This method is only available if the FieldDefinition object is taken from record layout or from the category layout. This indicates whether field linking should occur when an asset is saved. This feature is only supported with specific modules (like JPEG IPTC).
    
    Returns:
    the "Linking when Saving to Assets" state of the field.
  - getStringEnumIDs
```
public java.util.List<java.lang.Integer> getStringEnumIDs()
```
    Return the list of IDs for a String List field. This is only valid for a field of type FieldTypes.FieldTypeEnum. In case the field is set up to be ordered alphabetically the IDs are returned in the order for the default language.
    
    Returns:
    an array of IDs for the String List field.
    Since:
    
    8.0
  - getStringEnumIDs
```
public java.util.List<java.lang.Integer> getStringEnumIDs(int languageID)
```
    Return the list of IDs for a String List field. This is only valid for a field of type FieldTypes.FieldTypeEnum.
    
    Parameters:
    languageID - the Id of the language. This determines the order in which the IDs are returned in case the field is set up to be ordered alphabetically.
    
    Returns:
    an array of IDs for the String List field.
    Since:
    
    8.0
  - getStringEnumName
```
public java.lang.String getStringEnumName(int enumID)
```
    Returns the string enum name for the given id.
    
    Parameters:
    enumID - requested enum id
    
    Returns:
    string enum name for the given id
  - getStringEnumName
```
public java.lang.String getStringEnumName(int enumID,
                                 int languageID)
```
    Returns the string enum name for the given id and requested language.
    
    Parameters:
    enumID - requested enum id
    languageID - requested language
    
    Returns:
    string enum name for the given id and requested language
  - getValueInterpretation
```
public int getValueInterpretation()
```
    Returns the value interpretation for this field. The value interpretation is one of the following values:
    Returns:
    the value interpretation for this field.
  - getFieldUID
```
public GUID getFieldUID()
```
    Returns the field's GUID.
    
    Returns:
    the field's GUID.
  - getModuleClassUID
```
public GUID getModuleClassUID()
```
    Returns the module's GUID.
    
    Returns:
    the module's GUID.
  - getModuleName
```
public java.lang.String getModuleName(int language)
```
    Returns the module's name.
    
    Parameters:
    language - the language ID, see Cumulus for language ID definitions.
    
    Returns:
    the module's name.
  - getModuleName
```
public java.lang.String getModuleName()
```
    Returns the module's name using the default language.
    
    Returns:
    the module's name.
  - getName
```
public java.lang.String getName(int language)
```
    Returns the field's name in the given language.
    
    Parameters:
    language - the language ID, see Cumulus for language ID definitions.
    
    Returns:
    the field's name.
  - getName
```
public java.lang.String getName()
```
    Returns the field's name using the default language.
    
    Returns:
    the field's name.
  - getDefaultMasterCategoryName
```
public java.lang.String getDefaultMasterCategoryName()
```
    Returns the default master category name for the record "Categories" field.
    
    Returns:
    the default master category name.
  - getTableFieldUIDs
```
public java.util.Set<GUID> getTableFieldUIDs()
```
    In case of a table field this method returns the field UIDs for the sub table fields.
    
    Returns:
    in case of a table field this method returns the field UIDs for the sub table fields
  - isAtomicField
```
public boolean isAtomicField()
```
    Returns true when this field can be used on all tables or false if it's part of a sub-table definition only.
    
    Returns:
    true when this field can be used on all tables or false if it's part of a sub-table definition only
    Since:
    
    8.6
  - toString
```
public java.lang.String toString()
```
    Returns the field's name.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the field's name.
    See Also:
    getName(int)

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 FieldListEntry

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCumulusSession

getFieldType

allowUserToEdit

getIndexKind

linkWhenAdding

readAllWhenAdding

linkWhenUpdating

readAllWhenUpdating

linkWhenSaving

getStringEnumIDs

getStringEnumIDs

getStringEnumName

getStringEnumName

getValueInterpretation

getFieldUID

getModuleClassUID

getModuleName

getModuleName

getName

getName

getDefaultMasterCategoryName

getTableFieldUIDs

isAtomicField

toString