DocumentState
object for each lifecycle state that you want to define and add it to a DocumentLifecyclePolicy
object's DocumentStates
collection. Each lifecycle state must have a name, which is set by the
property. Each lifecycle state name must be unique within the lifecycle policy in which it is defined. To specify whether a given lifecycle state can be demoted or not, set its
property.
The order of the lifecycle states in a document lifecycle policy's
collection is important and determines the succession of lifecycle states. When a document that is associated with a document lifecycle policy is created, its initial lifecycle state is the first
object in the document lifecycle policy's
collection. To move a document into the next lifecycle state defined in the document lifecycle policy's
collection, call the document's
method and set its
parameter to the
constant. To move a document into the previous lifecycle state (unless the document's current lifecycle state's
property is set to
), set the method's
parameter to
.
The template permissions specified by the
property will be applied during a lifecycle state change if you set the
property to
; otherwise the permissions will not be applied. If the
property to set to
and you reset a document's lifecycle state, either by calling its
method and specifying
or by calling its
method while the
property on its document lifecycle policy is set to
, the access permissions will be reset to the access permissions of the initial lifecycle state.
The following tables list the members exposed by IDocumentState.
Public Properties
Name | Description | |
---|---|---|
![]() | ApplyTemplatePermissions | Specifies whether to apply the permissions associated with the security template to a given object on transition to a given document state. |
![]() | CanBeDemoted | Specifies whether a document, while in a given lifecycle state (as defined by its document lifecycle policy), can be demoted ( ) or not ( ). A value of indicates that a document's lifecycle state can be changed to the previous state that is defined by its document lifecycle policy. |
![]() | 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 |
![]() | 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 |
![]() | StateName | 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 property to the value of this property. |
![]() | TemplatePermissionDescriptions | A list of descriptions of permissions applicable to the template. This property represents the set of objects to be used when creating a security template. |
![]() | TemplatePermissions | Contains the set of discretionary objects to be used when creating a security template. |