|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides the functionality required by a worklist client application. A worklist bean has an associated workflow participant.
WorklistHome
Method Summary | |
java.lang.String |
getActiveOrganization()
Return the active organization. |
java.util.List |
getStartableWorkflows(java.lang.String orgID)
List the workflows that may be started manually. |
TaskInfo |
getTask(java.lang.String taskName,
java.lang.String instanceID)
Get a specific task. |
int[] |
getTaskCounts()
Return the number of assigned and overdue tasks on a user's worklist. |
java.util.List |
getTasks()
List the tasks assigned to the user who created this remote worklist object. |
java.util.List |
getTasks(java.lang.String orgID,
java.lang.String assigneeID,
boolean isRole)
List the tasks assigned to a participant. |
java.lang.String |
instantiateWorkflow(java.lang.String orgID,
java.lang.String templateID)
Create a new workflow instance. |
java.lang.String |
instantiateWorkflow(java.lang.String orgID,
java.lang.String templateID,
java.lang.Object requestId)
Create a new workflow instance with a transaction id. |
java.lang.String |
instantiateWorkflow(java.lang.String orgID,
java.lang.String templateID,
java.lang.String xml,
java.util.Map initialValues,
java.util.Map pluginData)
Create a new workflow instance, passing an XML document and initial variable values. |
java.lang.String |
instantiateWorkflow(java.lang.String orgID,
java.lang.String templateID,
java.lang.String xml,
java.util.Map initialValues,
java.util.Map pluginData,
java.lang.Object requestId)
Create a new workflow instance with a transaction id, passing an XML document and initial variable values. |
java.lang.String |
invokeWorkflowErrorHandler(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String handlerName,
java.lang.String xml)
Deprecated. Use invokeWorkflowExceptionHandler(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead. |
java.lang.String |
invokeWorkflowExceptionHandler(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String handlerName,
java.lang.String xml)
Invoke an exception handler for a workflow instance. |
java.lang.String |
invokeWorkflowExceptionHandler(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String handlerName,
java.lang.String xml,
java.lang.Object requestId)
Invoke an exception handler for a workflow instance with a transaction id. |
void |
ping()
A "dummy" method for the client to ping. |
java.lang.String |
response(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String nodeID,
java.lang.Object data)
Send the client's response to a previously received client request. |
java.lang.String |
response(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String nodeID,
java.lang.Object data,
java.lang.Object requestId)
Send the client's response to a previously received client request. |
java.lang.String |
response(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String nodeID,
java.lang.String xml)
Send the client's response to a previously received client request. |
void |
setActiveOrganization(java.lang.String orgID)
Set the active organization. |
java.lang.String |
taskAssign(java.lang.String templateDefinitionID,
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 |
taskAssign(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID,
java.lang.String assigneeID,
boolean isRole,
boolean bLoadBalance,
java.lang.Object requestId)
Assign a task to a participant with a transaction id. |
java.lang.String |
taskExecute(java.lang.String taskName,
java.lang.String instanceId)
Execute a task instance. |
java.lang.String |
taskExecute(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Execute a task instance. |
java.lang.String |
taskMarkDone(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Mark a task instance as complete. |
java.lang.String |
taskMarkDone(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID,
java.lang.Object requestId)
Mark a task instance as complete with a transaction id. |
java.lang.String |
taskSetProperties(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID,
int priority,
boolean doneWithoutDoit,
boolean doitIfDone,
boolean unmarkDone,
boolean modifible,
boolean reassignable)
Set the properties for a task instance. |
void |
taskUnassign(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Unassign a task. |
java.lang.String |
taskUnmarkDone(java.lang.String templateDefinitionID,
java.lang.String instanceID,
java.lang.String taskID)
Mark a task as incomplete. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome,
getHandle,
getPrimaryKey,
isIdentical,
remove |
Method Detail |
public void ping() throws java.rmi.RemoteException
public void setActiveOrganization(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization to set as active.public java.lang.String getActiveOrganization() throws java.rmi.RemoteException, WorkflowException
public int[] getTaskCounts() throws java.rmi.RemoteException, WorkflowException
element[0] |
the total number of tasks assigned to the user. |
element[1] |
the number of those tasks which are overdue. |
public java.util.List getTasks() throws java.rmi.RemoteException, WorkflowException
public java.util.List getTasks(java.lang.String orgID, java.lang.String assigneeID, boolean isRole) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization for which to list tasks.assigneeID
- The ID of the participant for whom to list tasks.isRole
- true
if assigneeID
is that of a
role.public TaskInfo getTask(java.lang.String taskName, java.lang.String instanceID) throws java.rmi.RemoteException, WorkflowException
taskName
- The task name that you are interested in.instanceID
- The ID of the instance to which this task belongs.public java.util.List getStartableWorkflows(java.lang.String orgID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization for which to list workflows.public java.lang.String instantiateWorkflow(java.lang.String orgID, java.lang.String templateID) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization in which to instantiate the
workflow.templateID
- The ID of the workflow template to instantiate.taskExecute(java.lang.String, java.lang.String, java.lang.String)
. The
caller can perform a SAX parse of this XML document to obtain the
instanceID
and templateDefinitionID
of the new
instance.instantiateWorkflow(String,String,String,Map,Map)
public java.lang.String instantiateWorkflow(java.lang.String orgID, java.lang.String templateID, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization in which to instantiate the
workflow.templateID
- The ID of the workflow template to instantiate.requestId
- The client request Id used for tracking the transaction
to make the method idempotent.taskExecute(java.lang.String, java.lang.String, java.lang.String)
. The
caller can perform a SAX parse of this XML document to obtain the
instanceID
and templateDefinitionID
of the new
instance.instantiateWorkflow(String,String)
public java.lang.String instantiateWorkflow(java.lang.String orgID, java.lang.String templateID, java.lang.String xml, java.util.Map initialValues, java.util.Map pluginData) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization in which to instantiate the
workflow.templateID
- The ID of the workflow template to instantiate.xml
- An XML document from which the new workflow instance can
initialize itself. Can be null
.initialValues
- Initial values for workflow variables. The
worklist bean maps keys to variable names in a case-insenstive way,
and attempts to use the corresponding values to initialize the variables
identified by the keys. Can be null
.pluginData
- A collection of plugin-defined instance data. The
map is keyed on plugin name, and each element is a plugin-defined
instance datum.taskExecute(java.lang.String, java.lang.String, java.lang.String)
. The
caller can perform a SAX parse of this XML document to obtain the
instanceID
and templateDefinitionID
of the new
instance.instantiateWorkflow(String,String)
public java.lang.String instantiateWorkflow(java.lang.String orgID, java.lang.String templateID, java.lang.String xml, java.util.Map initialValues, java.util.Map pluginData, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
orgID
- The ID of the organization in which to instantiate the
workflow.templateID
- The ID of the workflow template to instantiate.xml
- An XML document from which the new workflow instance can
initialize itself. Can be null
.initialValues
- Initial values for workflow variables. The
worklist bean maps keys to variable names in a case-insenstive way,
and attempts to use the corresponding values to initialize the variables
identified by the keys. Can be null
.pluginData
- A collection of plugin-defined instance data. The
map is keyed on plugin name, and each element is a plugin-defined
instance datum.requestId
- The client request Id used for tracking the transaction
to make the method idempotent.taskExecute(java.lang.String, java.lang.String, java.lang.String)
. The
caller can perform a SAX parse of this XML document to obtain the
instanceID
and templateDefinitionID
of the new
instance.instantiateWorkflow(String,String,String,Map,Map)
public java.lang.String taskExecute(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.public java.lang.String taskExecute(java.lang.String taskName, java.lang.String instanceId) throws java.rmi.RemoteException, WorkflowException
taskName
- The Name of the workflow template definition.instanceID
- The ID of the workflow instance.public java.lang.String taskMarkDone(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String taskMarkDone(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.requestId
- The client request Id used for tracking the transaction
to make the method idempotent.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String taskUnmarkDone(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String taskAssign(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, java.lang.String assigneeID, boolean isRole, boolean bLoadBalance) throws java.rmi.RemoteException, WorkflowException
bLoadBalance
argument.
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.assigneeID
- The ID of the participant to whom the task is to be
assigned.bRole
- 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 bRole
argument is false
.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String taskAssign(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, java.lang.String assigneeID, boolean isRole, boolean bLoadBalance, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
bLoadBalance
argument. The transaction
id is used for transaction audit trailing in clustering environment.
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.assigneeID
- The ID of the participant to whom the task is to be
assigned.bRole
- 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 bRole
argument is false
.requestId
- The client request Id used for tracking the transaction
to make the method idempotent.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public void taskUnassign(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.public java.lang.String taskSetProperties(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String taskID, int priority, boolean doneWithoutDoit, boolean doitIfDone, boolean unmarkDone, boolean modifible, boolean reassignable) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.taskID
- The ID of the task instance.priority
- The task instance priority (0=low, 1=medium, 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, 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
taskExecute(java.lang.String, 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, java.lang.String)
method).modifible
- true
to permit a user to modify a task
instance's runtime properties (by calling this method).reassignable
- 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, java.lang.String, boolean, boolean)
method).taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String response(java.lang.String templateDefinitionID, 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-defined 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.
templateDefinitionID
- The ID of the workflow template definition.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.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String response(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String nodeID, java.lang.Object data) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.instanceID
- The ID of the workflow instance.nodeID
- The ID of the object that raised the client request to
which this call is responding.data
- The client's request-specific response.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String response(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String nodeID, java.lang.Object data, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
ActionSendXMLToClient
action, using one of the standard
DTDs or a client-defined 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.
The transaction id is used for transaction audit trailing in clustering
environment.
templateDefinitionID
- The ID of the workflow template definition.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 definitionrequestId
- The client request Id used for tracking the transaction
to make the method idempotent.
called program response,
called Java class response,
message box response,
set variables response or
a custom format defined by the client.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String invokeWorkflowErrorHandler(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String handlerName, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
invokeWorkflowExceptionHandler(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
instead.
templateDefinitionID
- The ID of the workflow template definition.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 as the user-defined subtree
to the error handler.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String invokeWorkflowExceptionHandler(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String handlerName, java.lang.String xml) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.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 as the user-defined subtree
to the error handler.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.public java.lang.String invokeWorkflowExceptionHandler(java.lang.String templateDefinitionID, java.lang.String instanceID, java.lang.String handlerName, java.lang.String xml, java.lang.Object requestId) throws java.rmi.RemoteException, WorkflowException
templateDefinitionID
- The ID of the workflow template definition.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 as the user-defined subtree
to the error handler.requestId
- The client request Id used for tracking the transaction
to make the method idempotent.taskExecute(java.lang.String, java.lang.String, java.lang.String)
.
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |