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
constant values, which are stored in a
object's
property:
: ALONG
object that represents a choice list that holds integer-typeChoiceList
objects. EachChoice
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-typeChoice
objects. An integer-type choice list cannot contain any string-typeChoice
objects.Choice
: ASTRING
object that represents a choice list that holds string-typeChoiceList
objects. EachChoice
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-typeChoice
objects. A string-type choice list cannot contain any integer-typeChoice
objects.Choice
TypeID
constants, only LONG
and STRING
are valid constants for a ChoiceList
object's DataType
property. A
object is independently persistable (that is, it can be saved directly using its
method) and controls the state of any dependently persistable
objects that belong to it. You can access each
object that belong to a
object in the
collection that is specified by its
property. Each
object in this collection represents either an individual choice item or a group node for a nested collection of
objects.
A choice list's display name is stored in its
property and must be unique within an object store. Unlike a
object, a
object does not have a mechanism for localizing its display name.
Choice list hierarchy is specified by its
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
object that represents a group node, the server automatically sets this property to
.
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
property to the
object representing the choice list.
To create a new
object, call the
method. Set the appropriate properties and add any
objects to the
collection specified by its
property. Call the
method to save the new object to the persistent store. For the save to be successful you must, at a minimum, set the new
object's
and
properties.
Namespace: FileNet.Api.Admin
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 |
C++ |
---|
interface class IChoiceList : IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
J# |
---|
public interface IChoiceList implements IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
JScript |
---|
public interface IChoiceList extends IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable