DocumentState Properties

Specifies whether to apply the permissions associated with the security template to a given object on transition to a given document state.

Specifies whether a document, while in a given lifecycle state (as defined by its document lifecycle policy), can be demoted (true) or not (false). A value of true indicates that a document's lifecycle state can be changed to the previous state that is defined by its document lifecycle policy.

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

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.

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.

Specifies the name of this lifecycle state as defined by its document lifecycle policy. Each document lifecycle policy defines a set of states through which a document can transition into during its lifecycle. If this lifecycle state becomes a document's current lifecycle state, the server sets the document's CurrentState property to the value of this property.

A list of descriptions of permissions applicable to the template. This property represents the set of AccessPermissionDescription objects to be used when creating a security template.

Contains the set of discretionary AccessPermission objects to be used when creating a security template.