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.
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.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface IChoiceList _ Implements IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, _ IIndependentObject, IEngineObject, ICloneable |
C# |
---|
public interface IChoiceList : IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
Visual C++ |
---|
public interface class IChoiceList : IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
JavaScript |
---|
FileNet.Api.Admin.IChoiceList = function(); FileNet.Api.Admin.IChoiceList.createInterface('FileNet.Api.Admin.IChoiceList'); |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable