ChoiceList Properties

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

A ChoiceList object representing a set of allowable values. If it is associated with a property, ChoiceValues provides a discrete set of possible values that the property can hold. Otherwise, if a ChoiceValues is associated with a Choice object, it defines the set of possible values in a choice list group.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

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 (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Specifies a TypeID constant, which indicates the data type of the value that an object can hold.

For PropertyDescription, PropertyDefinition, and PropertyTemplate objects, this property is read-only and specifies the data type of the value that an object property can hold. Because the value of the DataType property is automatically set by the Content Engine server to correspond to the specific object type of the PropertyDescription, PropertyDefinition, or PropertyTemplate object, you do not need to set it when you are creating a property template or property definition. For example, in a PropertyDescriptionBinary, PropertyDefinitionBinary, or PropertyTemplateBinary object, the server automatically sets the DataType property to a value of BINARY.

For ChoiceList objects, this property is settable on create and must be a LONG or STRING constant value. This property determines whether a choice list is an integer-type choice list, which holds integer-type choice items or a string-type choice list, which holds string-type choice items.

For ColumnDefinition objects, this property is read-only and specifies the data type of the object property value that is stored in the represented database table column.

For CmIndexPartitionConstraint objects, this property is read-only and specifies the data type of an index partition constraint. Only the following values are valid:

• DATE: Specifies a date index partition constraint.
• STRING: Specifies a string index partition constraint.

The DataType property can have one of the values in the following table.

Name	Value	Description
BINARY	1	Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes.
BOOLEAN	2	Specifies a Boolean data type. Represents Boolean data having a value of true or false.
DATE	3	Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601.
DOUBLE	4	Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308.
GUID	5	Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
LONG	6	Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647.
OBJECT	7	Specifies an object data type. Represents an object that is instantiated from a Content Engine class.
STRING	8	Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters.

Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

• ClassDescription
• PropertyDescription
• ClassDefinition
• PropertyTemplate
• PropertyDefinition

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For CmAuditProcessingBookmark and AuditDefinition objects, this property is intended to identify client applications that process the audit log. For CmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For AuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For CmAuditProcessingBookmark and AuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple CmAuditProcessingBookmark or AuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.

Specifies whether a given choice list has a hierarchical structure (true) or not (false).

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 User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

• PropertyDescription.get_Id() is equal to PropertyTemplate.get_Id(), which is equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDescription.get_Id().

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Indicates the AddOn that installed this object. If null, this object was either created by the system or an external application.

Indicates the name of the user who last modified this object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

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 ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs. For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.