public interface DocumentLifecycleActionHandler
DocumentLifecycleActionHandler
implementation runs on the server.
Implement the methods of this interface with applicable actions
for state changes defined in the document's lifecycle policy.
The state of a document is changed when its changeState
method is called with the flag
parameter set to the appropriate LifecycleChangeFlags
constant.
When implementing a lifecycle action handler, consider the following points:
CodeModule
object,
or you can specify the action handler in the classpath of the application server where the Content Engine is running.Modifier and Type | Method and Description |
---|---|
void |
onDocumentClearException(Document doc,
DocumentLifecyclePolicy policy)
Executes when the lifecycle exception is cleared
(
changeState flag parameter is set to CLEAR_EXCEPTION ). |
void |
onDocumentDemote(Document doc,
DocumentLifecyclePolicy policy)
Executes when the lifecycle state is demoted
(
changeState flag parameter is set to DEMOTE ). |
void |
onDocumentPromote(Document doc,
DocumentLifecyclePolicy policy)
Executes when the lifecycle state of a document is promoted
(
changeState flag parameter is set to PROMOTE ). |
void |
onDocumentResetLifecycle(Document doc,
DocumentLifecyclePolicy policy)
Executes when the lifecycle state is reset
(
changeState flag parameter is set to RESET ). |
void |
onDocumentSetException(Document doc,
DocumentLifecyclePolicy policy)
Executes when the lifecycle state is set to the exception state
(
changeState flag parameter is set to SET_EXCEPTION ). |
void onDocumentPromote(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to PROMOTE
).doc
- A document whose lifecycle state is being changed.policy
- The lifecycle policy of the document.EngineRuntimeException
void onDocumentDemote(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to DEMOTE
).doc
- A document whose lifecycle state is being changed.policy
- The lifecycle policy of the document.EngineRuntimeException
void onDocumentSetException(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to SET_EXCEPTION
).doc
- A document whose lifecycle state is being changed.policy
- The lifecycle policy of the document.EngineRuntimeException
void onDocumentClearException(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to CLEAR_EXCEPTION
).doc
- A document whose lifecycle state is being changed.policy
- The lifecycle policy of the document.EngineRuntimeException
void onDocumentResetLifecycle(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to RESET
).doc
- A document whose lifecycle state is being changed.policy
- The lifecycle policy of the document.EngineRuntimeException
© Copyright IBM Corporation 2006, 2015. All rights reserved.