public interface DocumentLifecyclePolicy extends RepositoryObject, ActionConsumer
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.
DocumentState
,
DocumentLifecycleAction
Modifier and Type | Method and Description |
---|---|
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.
|
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
getObjectStore
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
DocumentLifecycleAction get_DocumentLifecycleAction()
void set_DocumentLifecycleAction(DocumentLifecycleAction value)
DocumentStateList get_DocumentStates()
void set_DocumentStates(DocumentStateList value)
java.lang.Boolean get_ResetLifecycleOnCheckin()
void set_ResetLifecycleOnCheckin(java.lang.Boolean value)
java.lang.Boolean get_PreserveDirectPermissions()
void set_PreserveDirectPermissions(java.lang.Boolean value)
void changeClass(java.lang.String className)
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:
null
if there is no default defined).null
) as the default value defined in the original class will be set
to the default value defined by the new class. However, any user-defined property that has had its value
modified from the default value will retain that modified value in the new class.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:
Changing the document class of a document object has no effect on the storage location of the document’s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer’s Guide.
className
- A String
specifying the symbolic name, ClassNames
constant, ID, or GUIDConstants
constant of the class to which this object is to be changed.E_NULL_OR_INVALID_PARAM_VALUE
- if className
is null
or has a length of zero.© Copyright IBM Corporation 2006, 2015. All rights reserved.