Content Engine Java API: ChoiceList

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
```
public interface ChoiceList
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
```
Represents a choice list in an object store. Each choice list contains a list collection of Choice objects that, when associated with a property, provides a discrete set of possible values that the property can hold. By using a choice list, you can enforce restrictions on property values.
There are two types of choice lists: integer and string. A choice list's type is specified by the following TypeID constant values, which are stored in a ChoiceList object's DataType property:
- LONG: A ChoiceList object that represents a choice list that holds integer-type Choice objects. Each Choice object in such a choice list must represent either an integer-type choice item or a group node that holds a nested collection of integer-type Choice objects. An integer-type choice list cannot contain any string-type Choice objects.
- STRING: A ChoiceList object that represents a choice list that holds string-type Choice objects. Each Choice object in such a choice list must represent either a string-type choice item or a group node that holds a nested collection of string-type Choice objects. A string-type choice list cannot contain any integer-type Choice objects.
Note that although there are eight TypeID constants, only LONG and STRING are valid constants for a ChoiceList object's DataType property.

A ChoiceList object is independently persistable (that is, it can be saved directly using its save method) and controls the state of any dependently persistable Choice objects that belong to it. You can access each Choice object that belong to a ChoiceList object in the com.filenet.api.collection.ChoiceList collection that is specified by its ChoiceValues property. Each Choice object in this collection represents either an individual choice item or a group node for a nested collection of Choice objects.

A choice list's display name is stored in its DisplayName property and must be unique within an object store. Unlike a Choice object, a ChoiceList object does not have a mechanism for localizing its display name.

Choice list hierarchy is specified by its HasHierarchy property. This read-only property indicates whether a given choice list has a hierarchical structure or not. If the choice list contains at least one Choice object that represents a group node, the server automatically sets this property to true.

For a choice list to be useful, it must be associated with a property. You can either associate a choice list with a property template, therefore causing it to be automatically associated with every property definition created from that property template, or you can associate a choice list with an individual property definition. To associate a choice list with a property template or a property definition, set its ChoiceList property to the com.filenet.api.admin.ChoiceList object representing the choice list.

To create a new ChoiceList object, call the Factory.ChoiceList.createInstance method. Set the appropriate properties and add any Choice objects to the com.filenet.api.collection.ChoiceList collection specified by its ChoiceValues property. Call the save method to save the new object to the persistent store. For the save to be successful you must, at a minimum, set the new ChoiceList object's DisplayName and DataType properties.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable

Method Summary

Methods
Modifier and Type	Method and Description
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`ChoiceList`	`get_ChoiceValues()` Returns the value of the ChoiceValues property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`TypeID`	`get_DataType()` Returns the value of the DataType property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`java.lang.String`	`get_DescriptiveText()` Returns the value of the DescriptiveText property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`java.lang.Boolean`	`get_HasHierarchy()` Returns the value of the HasHierarchy property.
`Id`	`get_Id()` Returns the value of the Id property.
`AddOn`	`get_InstalledByAddOn()` Returns the value of the InstalledByAddOn property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`java.lang.String`	`get_Name()` Returns the value of the Name property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`void`	`set_ChoiceValues(ChoiceList value)` Sets the value of the ChoiceValues property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DataType(TypeID value)` Sets the value of the DataType property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_DescriptiveText(java.lang.String value)` Sets the value of the DescriptiveText property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Name
```
java.lang.String get_Name()
```
    Returns the value of the Name property. For more information, see Name Property.
  - get_AuditedEvents
```
EventSet get_AuditedEvents()
```
    Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - set_DescriptiveText
```
void set_DescriptiveText(java.lang.String value)
```
    Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_DataType
```
TypeID get_DataType()
```
    Returns the value of the DataType property. For more information, see DataType Property.
  - set_DataType
```
void set_DataType(TypeID value)
```
    Sets the value of the DataType property. For more information, see DataType Property.
  - get_ChoiceValues
```
ChoiceList get_ChoiceValues()
```
    Returns the value of the ChoiceValues property. For more information, see ChoiceValues Property.
  - set_ChoiceValues
```
void set_ChoiceValues(ChoiceList value)
```
    Sets the value of the ChoiceValues property. For more information, see ChoiceValues Property.
  - get_HasHierarchy
```
java.lang.Boolean get_HasHierarchy()
```
    Returns the value of the HasHierarchy property. For more information, see HasHierarchy Property.
  - get_InstalledByAddOn
```
AddOn get_InstalledByAddOn()
```
    Returns the value of the InstalledByAddOn property. For more information, see InstalledByAddOn Property.

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.replication.Replicable

Methods inherited from interface com.filenet.api.core.Subscribable

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_Name

get_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_DisplayName

set_DisplayName

get_DescriptiveText

set_DescriptiveText

get_DataType

set_DataType

get_ChoiceValues

set_ChoiceValues

get_HasHierarchy

get_InstalledByAddOn