|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides behavior for workflow instances.
WorkflowProcessorHome
Method Summary | |
void |
eventTrigger(java.lang.String instanceId,
java.lang.String eventId,
org.w3c.dom.Node root)
Handle an XML event that was raised by the event processor. |
com.bea.wlpi.server.instance.WorkflowInstanceData |
getWorkflowInstanceData(java.lang.String instanceId)
Retrieve the runtime state of the associated workflow instance. |
java.lang.String |
instantiate(java.lang.String orgId,
java.lang.String initialNode,
java.lang.String parentTemplateDefinitionId,
java.lang.String parentId,
java.lang.String parentNodeId,
org.w3c.dom.Node root,
java.util.List variableValues)
Create a new workflow instance. |
java.lang.String |
instantiate(java.lang.String org,
java.lang.String initialNode,
java.lang.String parentTemplateDefinitionId,
java.lang.String parentId,
java.lang.String parentNodeId,
org.w3c.dom.Node root,
java.util.List variableValues,
com.bea.b2b.wlpi.ConversationController controller,
java.lang.String id)
Create a new workflow instance. |
java.lang.String |
invokeWorkflowErrorHandler(java.lang.String instanceId,
java.lang.String handlerName,
java.lang.String xml)
Invoke an error handler for a workflow instance. |
java.lang.String |
response(java.lang.String instanceId,
java.lang.String nodeId,
java.lang.String xml)
Send the client's response to a previously received client request. |
void |
setVariable(java.lang.String instanceId,
java.lang.String variable,
java.lang.Object value)
Assign a value to a workflow instance variable. |
void |
startedWorkflowDone(java.lang.String instanceId,
java.lang.String nodeId,
java.util.Collection output)
Notification that a sub-workflow has completed. |
java.lang.String |
taskAssign(java.lang.String instanceId,
java.lang.String taskId,
java.lang.String assigneeId,
boolean isRole,
boolean bLoadBalance)
Assign a task to a participant. |
java.lang.String |
taskDoit(java.lang.String instanceId,
java.lang.String taskId)
Execute a task instance. |
java.lang.String |
taskMarkDone(java.lang.String instanceId,
java.lang.String taskId)
Mark a task instance as complete. |
java.lang.String |
taskSetProperties(java.lang.String instanceId,
java.lang.String taskId,
int priority,
boolean doneWithoutDoit,
boolean doitIfDone,
boolean unmarkDone,
boolean modify,
boolean reassign)
Set the properties for a task instance. |
java.lang.String |
taskUnassign(java.lang.String instanceId,
java.lang.String taskId)
Assign a task. |
java.lang.String |
taskUnmarkDone(java.lang.String instanceId,
java.lang.String taskId)
Mark a task as incomplete. |
void |
timeTrigger(java.lang.String instanceId,
java.lang.String nodeId)
Handle a timed event that was raised by the time processor. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome,
getHandle,
getPrimaryKey,
isIdentical,
remove |
Method Detail |
public java.lang.String instantiate(java.lang.String orgId, java.lang.String initialNode, java.lang.String parentTemplateDefinitionId, java.lang.String parentId, java.lang.String parentNodeId, org.w3c.dom.Node root, java.util.List variableValues) throws java.rmi.RemoteException, WorkflowException
orgId
- The ID of the organization within which the instance is to run.initialNode
- The ID of the start node to activate.parentTemplateDefinitionId
- The ID of the parent template
definition (if instantiating a sub-workflow).parentId
- The ID of the parent workflow instance (if instantiating
a sub-workflow).parentNodeId
- The ID of the node in the parent workflow to be
notified of events in subflows life-cycle (if instantiating a sub-workflow).root
- The XML/DOM document element of the trigger event that
caused this method to be called.variableValues
- List of
VariableInfo objects to
initialize the workflow instance variables.public java.lang.String instantiate(java.lang.String org, java.lang.String initialNode, java.lang.String parentTemplateDefinitionId, java.lang.String parentId, java.lang.String parentNodeId, org.w3c.dom.Node root, java.util.List variableValues, com.bea.b2b.wlpi.ConversationController controller, java.lang.String id) throws WorkflowException, java.rmi.RemoteException
orgId
- Id of organization within which instance is to run.initialNode
- Id of start node to activate.parentTemplateDefinitionId
- Id of parent template definition (if
instantiating a sub-workflow).parentId
- Id of parent workflow instance (if instantiating a
sub-workflow).parentNodeId
- Id of node in parent workflow to be notified of
events in subflows life-cycle (if instantiating a sub-workflow).root
- XML/DOM document element of trigger event which caused this
method to be called.variableValues
- List of
VariableInfo objects to
initialize the workflow instance variables.public java.lang.String taskDoit(java.lang.String instanceId, java.lang.String taskId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.public java.lang.String taskMarkDone(java.lang.String instanceId, java.lang.String taskId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.taskDoit(java.lang.String, java.lang.String)
.public java.lang.String taskUnmarkDone(java.lang.String instanceId, java.lang.String taskId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.taskDoit(java.lang.String, java.lang.String)
.public java.lang.String taskAssign(java.lang.String instanceId, java.lang.String taskId, java.lang.String assigneeId, boolean isRole, boolean bLoadBalance) throws java.rmi.RemoteException, WorkflowException
bLoadBalance
argument.
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.assigneeId
- The ID of participant to whom the task is to be assigned.isRole
- true
if the assignee ID is that of a role,
false
if that of a user.bLoadBalance
- true
to request the system to perform
load-balancing within the specified role. This argument is ignored if
the isRole
argument is false
.taskDoit(java.lang.String, java.lang.String)
.public java.lang.String taskUnassign(java.lang.String instanceId, java.lang.String taskId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.taskDoit(java.lang.String, java.lang.String)
.public java.lang.String taskSetProperties(java.lang.String instanceId, java.lang.String taskId, int priority, boolean doneWithoutDoit, boolean doitIfDone, boolean unmarkDone, boolean modify, boolean reassign) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.taskId
- The ID of the task instance.priority
- The default task instance priority (0=low, 1=medium or
2=high).doneWithoutDoit
- true
to permit a user to mark a task
instance as complete (by calling the taskMarkDone(java.lang.String, java.lang.String)
method).doitIfDone
- true
to permit a user to execute
a task instance after it has been marked as complete (by calling the
taskDoit(java.lang.String, java.lang.String)
method).unmarkDone
- true
to permit a user to mark a task
instance as incomplete (by calling the taskUnmarkDone(java.lang.String, java.lang.String)
method).modify
- true
to permit a user to modify a task
instance's runtime properties (by calling this method).reassign
- true
to permit a user to reassign a task
instance to another participant (by calling the taskAssign(java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
method).taskDoit(java.lang.String, java.lang.String)
.public java.lang.String response(java.lang.String instanceId, java.lang.String nodeId, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
ActionSendXMLToClient
action, using one of the standard
DTDs or a client-define custom DTD. The response DTD matches the
request DTD and the XML document contains the results of executing the
server's request. The originating action typically uses the
XPath
function to extract the required values from the
document. Clients are free to define custom request and response DTDs.
instanceId
- The ID of the workflow instance.nodeId
- The ID of the object that raised the client request to
which this call is responding.xml
- The client's request-specific response (in XML format) compliant
with the document type definition
called program response,
called Java class response,
message box response,
set variables response or
a custom format defined by the client.taskDoit(java.lang.String, java.lang.String)
.public void eventTrigger(java.lang.String instanceId, java.lang.String eventId, org.w3c.dom.Node root) throws java.rmi.RemoteException, WorkflowException
instanceId
- Id of workflow instance.eventId
- Id of the event trigger record.root
- XML/DOM document element of trigger event that caused this
method to be called.public void timeTrigger(java.lang.String instanceId, java.lang.String nodeId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.nodeId
- The ID of the workflow node that scheduled the timed event.public void startedWorkflowDone(java.lang.String instanceId, java.lang.String nodeId, java.util.Collection output) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.nodeId
- The ID of the workflow node that started the sub-workflow.output
- A collection of
VariableInfo objects
containing the output variable values, representing the final runtime
state of the subflow instance.public void setVariable(java.lang.String instanceId, java.lang.String variable, java.lang.Object value) throws java.rmi.RemoteException, WorkflowException
instanceId
- The ID of the workflow instance.variable
- The name of the variable.value
- The value to assign.public java.lang.String invokeWorkflowErrorHandler(java.lang.String instanceId, java.lang.String handlerName, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
instanceId
- The id of the workflow instance for which the error
handler should be invoked.handlerName
- The name of the error handler to invoke.xml
- The XML document to pass to the error handler.taskDoit(java.lang.String, java.lang.String)
.public com.bea.wlpi.server.instance.WorkflowInstanceData getWorkflowInstanceData(java.lang.String instanceId) throws java.rmi.RemoteException, WorkflowException
instanceId
- The workflow instance ID.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |