com.filenet.api.events
Interface DocumentLifecyclePolicy

All Superinterfaces:
ActionConsumer, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

public interface DocumentLifecyclePolicy
extends RepositoryObject, ActionConsumer

Represents the lifecycle policy for a document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes.

To define the lifecycle states in a document lifecycle policy, create a DocumentState object for each lifecycle state that you want to define and add it to the DocumentStateList collection referenced by the DocumentState property. You can set the ResetLifecycleOnCheckin property to define whether a document, when it is checked in, is reset to the initial lifecycle state in its document lifecycle policy or not. To define the actions to be taken when a document's lifecycle state changes, create a DocumentLifecycleAction object and set the DocumentLifecycleAction property to reference it. With the PreseveDirectPermissions property, you can elect to either preserve a document's direct (non-inherited) access permissions or replace them with the document lifecycle policy's access permissions.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: ActionConsumer

See Also:
DocumentState, DocumentLifecycleAction

Method Summary
 void changeClass(java.lang.String className)
          Changes the class of a Content Engine object.
 DocumentLifecycleAction get_DocumentLifecycleAction()
          Returns the value of the DocumentLifecycleAction property.
 DocumentStateList get_DocumentStates()
          Returns the value of the DocumentStates property.
 java.lang.Boolean get_PreserveDirectPermissions()
          Returns the value of the PreserveDirectPermissions property.
 java.lang.Boolean get_ResetLifecycleOnCheckin()
          Returns the value of the ResetLifecycleOnCheckin property.
 void set_DocumentLifecycleAction(DocumentLifecycleAction value)
          Sets the value of the DocumentLifecycleAction property.
 void set_DocumentStates(DocumentStateList value)
          Sets the value of the DocumentStates property.
 void set_PreserveDirectPermissions(java.lang.Boolean value)
          Sets the value of the PreserveDirectPermissions property.
 void set_ResetLifecycleOnCheckin(java.lang.Boolean value)
          Sets the value of the ResetLifecycleOnCheckin property.
 
Methods inherited from interface com.filenet.api.events.ActionConsumer
get_ActiveMarkings, get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions
 
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_DocumentLifecycleAction

DocumentLifecycleAction get_DocumentLifecycleAction()
Returns the value of the DocumentLifecycleAction property. For more information, see DocumentLifecycleAction Property.


set_DocumentLifecycleAction

void set_DocumentLifecycleAction(DocumentLifecycleAction value)
Sets the value of the DocumentLifecycleAction property. For more information, see DocumentLifecycleAction Property.


get_DocumentStates

DocumentStateList get_DocumentStates()
Returns the value of the DocumentStates property. For more information, see DocumentStates Property.


set_DocumentStates

void set_DocumentStates(DocumentStateList value)
Sets the value of the DocumentStates property. For more information, see DocumentStates Property.


get_ResetLifecycleOnCheckin

java.lang.Boolean get_ResetLifecycleOnCheckin()
Returns the value of the ResetLifecycleOnCheckin property. For more information, see ResetLifecycleOnCheckin Property.


set_ResetLifecycleOnCheckin

void set_ResetLifecycleOnCheckin(java.lang.Boolean value)
Sets the value of the ResetLifecycleOnCheckin property. For more information, see ResetLifecycleOnCheckin Property.


get_PreserveDirectPermissions

java.lang.Boolean get_PreserveDirectPermissions()
Returns the value of the PreserveDirectPermissions property. For more information, see PreserveDirectPermissions Property.


set_PreserveDirectPermissions

void set_PreserveDirectPermissions(java.lang.Boolean value)
Sets the value of the PreserveDirectPermissions property. For more information, see PreserveDirectPermissions Property.


changeClass

void changeClass(java.lang.String className)
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

Parameters:
className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
Throws:
E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.


© Copyright IBM Corporation 2006, 2009. All rights reserved.