| java.lang.Object xflow.client.WorkflowManager
WorkflowManager | public class WorkflowManager (Code) | | WorkflowManager contains all workflow administrative functions.
Clients needing to perform functions such as starting/aborting workflows,
deploying workflows, etc should invoke methods from this class.
|
Method Summary | |
public static void | abortWorkflow(WorkflowId workflowId, User user) | public static void | deployModel(String xml, String type, User user) Deploys a workflow model from an XML document
Parameters: xml - the XML document Parameters: type - the XML document type valid type currently supported is: XFLOW. | public static Vector | getActiveWorkflows(User user) | public static Vector | getAllWorkflows(User user) | public static Vector | getAllWorkflowsByName(String name, User user) | public static Node | getNodeByName(String workflowName, int workflowVersion, String name, User user) | public static Vector | getProcessNodes(WorkflowId workflowId, User user) | public static Object | getVariable(WorkflowId workflowId, String variableName, User user) | public static Vector | getWorkflowModels(User user) | public static WorkflowState | getWorkflowState(WorkflowId workflowId, User user) | public static void | resumeWorkflow(WorkflowId workflowId, User user) | public static void | setVariable(WorkflowId workflowId, String variableName, Object variableValue, User user) | public static WorkflowId | startWorkflow(String workflowName, WorkItem workItem, User user) Starts a workflow. | public static WorkflowId | startWorkflow(String workflowName, int workflowVersion, WorkItem workItem, User user) | public static void | suspendWorkflow(WorkflowId workflowId, User user) |
abortWorkflow | public static void abortWorkflow(WorkflowId workflowId, User user) throws XflowException(Code) | | Aborts an active workflow instance
Parameters: workflowId - the workflow instance ID Parameters: user - the user requesting the abort exception: XflowException - |
deployModel | public static void deployModel(String xml, String type, User user) throws XflowException(Code) | | Deploys a workflow model from an XML document
Parameters: xml - the XML document Parameters: type - the XML document type valid type currently supported is: XFLOW. BPEL in the near future Parameters: user - the user exception: XflowException - |
getActiveWorkflows | public static Vector getActiveWorkflows(User user) throws XflowException(Code) | | Gets all active workflow instances
Parameters: user - the user the list of WorkflowState objects of currently active workflow instances exception: XflowException - |
getAllWorkflows | public static Vector getAllWorkflows(User user) throws XflowException(Code) | | Gets all workflow instances
Parameters: user - the user the list of WorkflowState objects of all workflow instances exception: XflowException - |
getAllWorkflowsByName | public static Vector getAllWorkflowsByName(String name, User user) throws XflowException(Code) | | Gets all workflow instances
Parameters: name - the workflow model name Parameters: user - the user the list of WorkflowState objects of all workflow instances exception: XflowException - |
getNodeByName | public static Node getNodeByName(String workflowName, int workflowVersion, String name, User user) throws XflowException(Code) | | Gets all process nodes participating in a workflow instance
Parameters: workflowName - the workflow model name Parameters: workflowVersion - the workflow version (-1 means get the latest) Parameters: nodeName - the node name Parameters: user - the user the Node object exception: XflowException - |
getProcessNodes | public static Vector getProcessNodes(WorkflowId workflowId, User user) throws XflowException(Code) | | Gets all process nodes participating in a workflow instance
Parameters: workflowId - the workflow instance ID Parameters: user - the user the list of Node objects exception: XflowException - |
getVariable | public static Object getVariable(WorkflowId workflowId, String variableName, User user) throws XflowException(Code) | | Gets a variable for a specified workflow instance
Parameters: workflowId - the workflow instance ID Parameters: variableName - the variable name Parameters: user - the user the variable value exception: XflowException - |
resumeWorkflow | public static void resumeWorkflow(WorkflowId workflowId, User user) throws XflowException(Code) | | Resumes a suspended workflow instance
Parameters: workflowId - the workflow instance ID Parameters: user - the user requesting the resume exception: XflowException - |
setVariable | public static void setVariable(WorkflowId workflowId, String variableName, Object variableValue, User user) throws XflowException(Code) | | Sets a variable for a specified workflow instance
Parameters: workflowId - the workflow instance ID Parameters: variableName - the variable name Parameters: variableValue - the variable value - must be serializable Parameters: user - the user exception: XflowException - |
startWorkflow | public static WorkflowId startWorkflow(String workflowName, WorkItem workItem, User user) throws XflowException(Code) | | Starts a workflow.
Parameters: workflowName - the workflow name Parameters: workItem - the work item Parameters: user - the initiator of the workflow the workflow ID of the newly created workflow instance exception: XflowException - |
startWorkflow | public static WorkflowId startWorkflow(String workflowName, int workflowVersion, WorkItem workItem, User user) throws XflowException(Code) | | Starts a workflow with a specified version
Parameters: workflowName - the workflow name Parameters: workflowVersion - the workflow version Parameters: workItem - the work item Parameters: user - the initiator of the workflow the workflow ID of the newly created workflow instance exception: XflowException - |
suspendWorkflow | public static void suspendWorkflow(WorkflowId workflowId, User user) throws XflowException(Code) | | Suspends an active workflow instance
Parameters: workflowId - the workflow instance ID Parameters: user - the user requesting the suspend exception: XflowException - |
|
|