|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowComponent
SPI to be implemented by a BPM Engine that provides Workflow instance management.
Method Summary | |
---|---|
WorkflowInstance |
cancelWorkflow(java.lang.String workflowId)
Cancel an "in-flight" Workflow instance |
WorkflowInstance |
deleteWorkflow(java.lang.String workflowId)
Delete an "in-flight" Workflow instance |
WorkflowDeployment |
deployDefinition(java.io.InputStream workflowDefinition,
java.lang.String mimetype)
Deploy a Workflow Definition |
WorkflowDeployment |
deployDefinition(java.io.InputStream workflowDefinition,
java.lang.String mimetype,
java.lang.String name)
Deploy a Workflow Definition |
WorkflowPath |
fireEvent(java.lang.String pathId,
java.lang.String event)
Fire custom event against specified path |
java.util.List |
getActiveWorkflows()
Gets all "in-flight" active workflow instances. |
java.util.List |
getActiveWorkflows(java.lang.String workflowDefinitionId)
Gets all "in-flight" active workflow instances of the specified Workflow Definition |
java.util.List |
getAllDefinitions()
Gets all deployed Workflow Definitions (with all previous versions) |
java.util.List |
getAllDefinitionsByName(java.lang.String workflowName)
Gets all (including previous) Workflow Definitions for the given unique name |
java.util.List |
getCompletedWorkflows()
Gets all completed workflow instances. |
java.util.List |
getCompletedWorkflows(java.lang.String workflowDefinitionId)
Gets all "in-flight" completed workflow instances of the specified Workflow Definition |
WorkflowDefinition |
getDefinitionById(java.lang.String workflowDefinitionId)
Gets a Workflow Definition by unique Id |
WorkflowDefinition |
getDefinitionByName(java.lang.String workflowName)
Gets a Workflow Definition by unique name |
byte[] |
getDefinitionImage(java.lang.String workflowDefinitionId)
Gets a graphical view of the Workflow Definition |
java.util.List |
getDefinitions()
Gets all deployed Workflow Definitions |
java.util.Map |
getPathProperties(java.lang.String pathId)
Gets the properties associated with the specified path (and parent paths) |
java.util.List |
getTaskDefinitions(java.lang.String workflowDefinitionId)
Gets the Task Definitions for the given Workflow Definition |
java.util.List |
getTasksForWorkflowPath(java.lang.String pathId)
Gets all Tasks associated with the specified path |
java.util.List |
getTimers(java.lang.String workflowId)
Gets all active timers for the specified workflow |
WorkflowInstance |
getWorkflowById(java.lang.String workflowId)
Gets a specific workflow instances |
java.io.InputStream |
getWorkflowImage(java.lang.String workflowInstanceId)
Gets a graphical view of the workflow instance |
java.util.List |
getWorkflowPaths(java.lang.String workflowId)
Gets all Paths for the specified Workflow instance |
java.util.List |
getWorkflows()
Gets all workflow instances (both active and completed). |
java.util.List |
getWorkflows(java.lang.String workflowDefinitionId)
Gets all "in-flight" workflow instances (both active and completed) of the specified Workflow Definition |
boolean |
hasWorkflowImage(java.lang.String workflowInstanceId)
Determines if a graphical view of the workflow instance exists |
boolean |
isDefinitionDeployed(java.io.InputStream workflowDefinition,
java.lang.String mimetype)
Is the specified Workflow Definition already deployed? Note: the notion of "already deployed" may differ between bpm engines. |
WorkflowPath |
signal(java.lang.String pathId,
java.lang.String transitionId)
Signal the transition from one Workflow Node to another within an "in-flight" process. |
WorkflowPath |
startWorkflow(java.lang.String workflowDefinitionId,
java.util.Map parameters)
Start a Workflow Instance |
void |
undeployDefinition(java.lang.String workflowDefinitionId)
Undeploy an exisiting Workflow Definition TODO: Determine behaviour when "in-flight" workflow instances exist |
Method Detail |
---|
WorkflowDeployment deployDefinition(java.io.InputStream workflowDefinition, java.lang.String mimetype)
workflowDefinition
- the content object containing the definitionmimetype
- (optional) the mime type of the workflow definition
WorkflowDeployment deployDefinition(java.io.InputStream workflowDefinition, java.lang.String mimetype, java.lang.String name)
workflowDefinition
- the content object containing the definitionmimetype
- (optional) the mime type of the workflow definitionname
- (optional) a name to represent the deployment
boolean isDefinitionDeployed(java.io.InputStream workflowDefinition, java.lang.String mimetype)
workflowDefinition
- the definition to checkmimetype
- the mimetype of the definition
void undeployDefinition(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the id of the definition to undeployjava.util.List getDefinitions()
@Auditable java.util.List getAllDefinitions()
WorkflowDefinition getDefinitionById(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
WorkflowDefinition getDefinitionByName(java.lang.String workflowName)
workflowName
- workflow name e.g. jbpm$wf:review
@Auditable(parameters="workflowName") java.util.List getAllDefinitionsByName(java.lang.String workflowName)
workflowName
- workflow name e.g. jbpm$wf:review
@Auditable(parameters="workflowDefinitionId") byte[] getDefinitionImage(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
@Auditable(parameters="workflowDefinitionId") java.util.List getTaskDefinitions(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
WorkflowPath startWorkflow(java.lang.String workflowDefinitionId, java.util.Map parameters)
workflowDefinitionId
- the workflow definition idparameters
- the initial set of parameters used to populate the "Start Task" properties
java.util.List getActiveWorkflows(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
java.util.List getCompletedWorkflows(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
java.util.List getWorkflows(java.lang.String workflowDefinitionId)
workflowDefinitionId
- the workflow definition id
java.util.List getActiveWorkflows()
java.util.List getCompletedWorkflows()
java.util.List getWorkflows()
WorkflowInstance getWorkflowById(java.lang.String workflowId)
workflowId
- the id of the workflow to retrieve
java.util.List getWorkflowPaths(java.lang.String workflowId)
workflowId
- workflow instance id
java.util.Map getPathProperties(java.lang.String pathId)
pathId
- workflow path id
WorkflowInstance cancelWorkflow(java.lang.String workflowId)
workflowId
- the workflow instance to cancel
WorkflowInstance deleteWorkflow(java.lang.String workflowId)
workflowId
- the workflow instance to cancel
WorkflowPath signal(java.lang.String pathId, java.lang.String transitionId)
pathId
- the workflow path to signal ontransition
- the transition to follow (or null, for the default transition)
WorkflowPath fireEvent(java.lang.String pathId, java.lang.String event)
pathId
- the workflow path to fire event onevent
- name of event
java.util.List getTasksForWorkflowPath(java.lang.String pathId)
pathId
- the path id
java.util.List getTimers(java.lang.String workflowId)
boolean hasWorkflowImage(java.lang.String workflowInstanceId)
workflowInstanceId
- the workflow instance id
java.io.InputStream getWorkflowImage(java.lang.String workflowInstanceId)
workflowInstanceId
- the workflow instance id
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |