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.
The following tables list the members exposed by IChoiceList.
Public Properties
Name | Description | |
---|---|---|
![]() | AuditedEvents | An collection of the objects containing the audited events that have occurred for the object. |
![]() | ChoiceValues | A object representing a set of allowable values. If it is associated with a property, provides a discrete set of possible values that the property can hold. Otherwise, if a is associated with a object, it defines the set of possible values in a choice list group. |
![]() | Creator | Indicates the name of the user assigned as the creator of the object. Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() | DataType | Specifies a constant, which indicates the data type of the value that an object property, choice list, or database table column can hold. For For For |
![]() | DateCreated | Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC). Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() | DateLastModified | Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC). Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() | DescriptiveText | User-readable text that describes an object. The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | DisplayName | The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class. |
![]() | HasHierarchy | Specifies whether a given choice list has a hierarchical structure (true) or not (false). |
![]() | Id | A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. For For a given property representation, the Id property has the following characteristics:
For a newly created document object, you can override the Id property of its associated |
![]() | LastModifier | Indicates the name of the user who last modified the object. Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() | Name | The name for this object. For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If For a |
![]() | Owner | Manages the security owner assigned to the object. |
![]() | Permissions | Manages the discretionary permissions assigned to the object. |