public interface DocumentLifecycleAction extends RepositoryObject, Action
DocumentStateList
collection of its associated DocumentLifecyclePolicy
object. 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 when a
document's lifecycle state changes. To change the lifecycle state of a document, call its changeState
method; you can change a
document's current lifecycle state to another predefined state, set it to an exception state, or clear it from an exception state by specifying
the appropriate LifecycleChangeFlags
constant in the flags
parameter.
To define the actions to take when a document’s lifecycle state is changed, write a JavaScript or Java handler class that implements the
DocumentLifecycleActionHandler
interface.
Modifier and Type | Method and Description |
---|---|
void |
changeClass(java.lang.String className)
Changes the class of a Content Engine object.
|
DocumentLifecyclePolicySet |
get_DocumentLifecyclePolicies()
Returns the value of the DocumentLifecyclePolicies property.
|
get_ActiveMarkings, get_AuditedEvents, get_CodeModule, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, get_ProgId, get_ScriptText, set_CodeModule, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions, set_ProgId, set_ScriptText
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
DocumentLifecyclePolicySet get_DocumentLifecyclePolicies()
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.