This topic alphabetically lists the properties that apply to the Choice class.
Choice object that holds an integer data type in a choice list.
Choice object that holds a string data type in a choice list.
ChoiceType constant that determines the type of data that a Choice object represents:
an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type Choice objects,
or a group node for a nested collection of string-type Choice objects.
The ChoiceType property can have one of the values in the following table.
| Name | Value | Description |
|---|---|---|
INTEGER |
0 | Specifies a Choice object that represents an integer-type choice item. |
MIDNODE_INTEGER |
2 | Specifies a Choice object that acts as a group node for a nested collection of integer-type
Choice objects. Each Choice object in this collection must represent either an integer-type
choice item or a group node for a nested collection of integer-type Choice objects. |
MIDNODE_STRING |
3 | Specifies a Choice object that acts as a group node for a nested collection of string-type
Choice objects. Each Choice object in this collection must represent either a string-type
choice item or a group node for a nested collection of string-type Choice objects. |
STRING |
1 | Specifies a Choice object that represents a string-type choice item. |
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.
ClassDescription object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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.
LocalizedStringList object containing a collection of LocalizedString
objects, each of which represents a locale-specific, user-readable display name for a
class definition, property template, or choice.
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.
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.