| org.apache.lenya.workflow.WorkflowManager
All known Subclasses: org.apache.lenya.workflow.impl.WorkflowManagerImpl,
WorkflowManager | public interface WorkflowManager (Code) | | Manager for workflow issues. This is the main entry point for
workflow-related tasks. You can safely invoke all methods for non-workflow
documents.
version: $Id: WorkflowManager.java 179751 2005-06-03 09:13:35Z andreas $ |
Method Summary | |
boolean | canInvoke(Workflowable workflowable, String event) Checks if an event can be invoked on a document.
Parameters: workflowable - The workflowable. Parameters: event - The event. | Workflow | getWorkflowSchema(Workflowable workflowable) Resolves the workflow schema of a workflowable.
Parameters: workflowable - The workflowable. | boolean | hasWorkflow(Workflowable workflowable) Checks if a workflowable has a workflow.
Parameters: workflowable - The workflowable. | void | invoke(Workflowable workflowable, String event) Invokes a workflow event on a document. | void | invoke(Workflowable workflowable, String event, boolean force) Invokes a workflow event on a document.
Parameters: workflowable - The document. Parameters: event - The name of the event. Parameters: force - If this is set to true , the execution isforced, which means an exception is thrown if the workflowable inthe set does not support the event. |
canInvoke | boolean canInvoke(Workflowable workflowable, String event)(Code) | | Checks if an event can be invoked on a document.
Parameters: workflowable - The workflowable. Parameters: event - The event. A boolean value. |
hasWorkflow | boolean hasWorkflow(Workflowable workflowable)(Code) | | Checks if a workflowable has a workflow.
Parameters: workflowable - The workflowable. A boolean value. |
invoke | void invoke(Workflowable workflowable, String event) throws WorkflowException(Code) | | Invokes a workflow event on a document. This is the same as
invoke(Document, String, true) .
Parameters: workflowable - The workflowable. Parameters: event - The name of the event. throws: WorkflowException - if the event could not be invoked in thecurrent situation. |
invoke | void invoke(Workflowable workflowable, String event, boolean force) throws WorkflowException(Code) | | Invokes a workflow event on a document.
Parameters: workflowable - The document. Parameters: event - The name of the event. Parameters: force - If this is set to true , the execution isforced, which means an exception is thrown if the workflowable inthe set does not support the event. If set tofalse , non-supporting documents are ignored. throws: WorkflowException - if the event could not be invoked in thecurrent situation. |
|
|