CmIndexPartitionConstraintString Properties

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

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.

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.

For CmIndexPartitionConstraint objects, the name of a CBR-enabled object property that is assigned in an object store to act as a partition constraint for an IBM® Content Search Services index. This property is read-only and is assigned by the Content Engine server when the index is created.

For CmTextSearchPartitionProperty objects, the name of a CBR-enabled object property that is assigned in an object store to act as an index partitioning property for IBM Content Search Services. This read/write property must be a custom string- or date-valued property and have a settability of SETTABLE_ONLY_ON_CREATE. You can have no more than one string and one date index partitioning property assigned in an object store.

The value of the string partition constraint for an IBM® Content Search Services index. This property is set by the Content Engine server when the index is created. If there is no string partition constraint on this index, the value of this property is null.