|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentLifecycleActionHandler
An interface to be implemented to handle state changes for documents assigned a lifecycle policy.
A DocumentLifecycleActionHandler
implementation runs on the server.
To implement this interface, create a class and implement the methods 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 in a Content Engine object store,
or you can specify the action handler in the classpath of the application server where the Content Engine is running.
See Deploying Action Handlers for more information.For restrictions and best practices on implementing action handlers, see Implementation Concepts.
DocumentLifecyclePolicy
,
DocumentLifecycleAction
,
changeState
,
Working with Lifecycle-related ObjectsMethod Summary | |
---|---|
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 ). |
Method Detail |
---|
void onDocumentPromote(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to PROMOTE
).
doc
- A Document
object that specifies the document whose lifecycle state is being changed.policy
- A DocumentLifecyclePolicy
object that specifies the document's lifecycle policy.
EngineRuntimeException
void onDocumentDemote(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to DEMOTE
).
doc
- A Document
object that specifies the document whose lifecycle state is being changed.policy
- A DocumentLifecyclePolicy
object that specifies the document's lifecycle policy.
EngineRuntimeException
void onDocumentSetException(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to SET_EXCEPTION
).
doc
- A Document
object that specifies the document whose lifecycle state is being changed.policy
- A DocumentLifecyclePolicy
object that specifies the document's lifecycle policy.
EngineRuntimeException
void onDocumentClearException(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to CLEAR_EXCEPTION
).
doc
- A Document
object that specifies the document whose lifecycle state is being changed.policy
- A DocumentLifecyclePolicy
object that specifies the document's lifecycle policy.
EngineRuntimeException
void onDocumentResetLifecycle(Document doc, DocumentLifecyclePolicy policy) throws EngineRuntimeException
changeState
flag
parameter is set to RESET
).
doc
- A Document
object that specifies the document whose lifecycle state is being changed.policy
- A DocumentLifecyclePolicy
object that specifies the document's lifecycle policy.
EngineRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |