Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle BPEL Process Manager
Workflow Services API Reference
10g Release 3 (10.1.3)
B28985-02
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.bpel.services.workflow.task
Interface ITaskService

public interface ITaskService

Method Summary
 Task acquireTask(IWorkflowContext context, java.lang.String taskId)
          Acquire the task
 Task acquireTask(IWorkflowContext context, Task task)
          Acquire the task
 boolean acquireTasks(IWorkflowContext context, java.util.List taskIds)
          Acquire all the tasks identified by their task id in the specified list
 Task addAttachment(IWorkflowContext context, java.lang.String taskId, AttachmentType attachment)
          Add a attachment
 Task addAttachment(IWorkflowContext context, Task task, AttachmentType attachment)
          Add a attachment
 Task addComment(IWorkflowContext context, java.lang.String taskId, java.lang.String comment)
          Add a comment
 Task addComment(IWorkflowContext context, Task task, java.lang.String comment)
          Add a comment
 Task delegateTask(IWorkflowContext context, java.lang.String taskId, java.util.List taskAssignees)
          Delegate the task
 Task delegateTask(IWorkflowContext context, Task task, java.util.List taskAssignees)
          Delegate the task
 Task errorTask(IWorkflowContext context, java.lang.String taskId)
          Error the task
 Task errorTask(IWorkflowContext context, Task task)
          Error the task
 Task escalateTask(IWorkflowContext context, java.lang.String taskId)
          Escalate the task
 Task escalateTask(IWorkflowContext context, Task task)
          Escalate the task
 java.util.List getApprovers(IWorkflowContext context, java.lang.String taskId)
          Get all the approvers of the task
 java.util.List getApprovers(IWorkflowContext context, Task task)
          Get all the approvers of the task
 RoutingSlip getFutureParticipants(IWorkflowContext context, java.lang.String taskId)
          Get all the future participants for the task
 RoutingSlip getFutureParticipants(IWorkflowContext context, Task task)
          Get all the future participants for the task
 java.util.List getUsersToRequestInfoForTask(IWorkflowContext context, java.lang.String taskId)
          Get the list of users from whom request for information can be requested
 java.util.List getUsersToRequestInfoForTask(IWorkflowContext context, Task task)
          Get the list of users from whom request for information can be requested
 IInitiateTaskResponse initiateTask(Task task)
          Initiate a task
 Task mergeAndUpdateTask(IWorkflowContext context, Task task)
          Merge and update a task.
 Task overrideRoutingSlip(IWorkflowContext context, java.lang.String taskId, java.lang.String routingSlipURI)
          Override current routing slip.
 Task overrideRoutingSlip(IWorkflowContext context, Task task, java.lang.String routingSlipURI)
          Override current routing slip.
 Task pushBackTask(IWorkflowContext context, java.lang.String taskId)
          PushBack the task to the previous approver/original assignees.
 Task pushBackTask(IWorkflowContext context, Task task)
          PushBack the task to the previous approver/original assignees.
 Task reassignTask(IWorkflowContext context, java.lang.String taskId, java.util.List taskAssignees)
          Reassign the task
 Task reassignTask(IWorkflowContext context, Task task, java.util.List taskAssignees)
          Reassign the task
 IInitiateTaskResponse reinitiateTask(Task task)
          Reinitiate a task
 Task releaseTask(IWorkflowContext context, java.lang.String taskId)
          Release the task
 Task releaseTask(IWorkflowContext context, Task task)
          Release the task
 boolean releaseTasks(IWorkflowContext context, java.util.List taskIds)
          Release all the tasks identified by their task id in the specified list
 Task removeAttachment(IWorkflowContext context, java.lang.String taskId, java.util.List attachmentNames)
          Remove all task attachments identified by the list of attachment names
 Task removeAttachment(IWorkflowContext context, Task task, java.util.List attachmentNames)
          Remove all task attachments identified by the list of attachment names
 Task renewTask(IWorkflowContext context, java.lang.String taskId, org.exolab.types.Duration duration)
          Renew the task
 Task renewTask(IWorkflowContext context, Task task, org.exolab.types.Duration duration)
          Renew the task
 Task requestInfoForTask(IWorkflowContext context, java.lang.String taskId, ITaskAssignee taskAssignee)
          Request for more information
 Task requestInfoForTask(IWorkflowContext context, Task task, ITaskAssignee taskAssignee)
          Request for more information
 Task requestInfoForTaskWithReapproval(IWorkflowContext context, java.lang.String taskId, ITaskAssignee taskAssignee)
          Request for more information and once the information is submitted, initiate reapproval from all the previous approvers since the user who submitted the information
 Task requestInfoForTaskWithReapproval(IWorkflowContext context, Task task, ITaskAssignee taskAssignee)
          Request for more information and once the information is submitted, initiate reapproval from all the previous approvers since the user who submitted the information
 Task resumeTask(IWorkflowContext context, java.lang.String taskId)
          Resume the task
 Task resumeTask(IWorkflowContext context, Task task)
          Resume the task
 boolean resumeTasks(IWorkflowContext context, java.util.List taskIds)
          Resume all the tasks identified by their task id in the specified list
 Task routeTask(IWorkflowContext context, java.lang.String taskId, Participants participants)
          Route the task to the specified participant.
 Task routeTask(IWorkflowContext context, Task task, Participants participants)
          Route the task to the specified participant.
 Task skipCurrentAssignment(IWorkflowContext context, java.lang.String taskId)
          Skip current assignment and interpret the routing slip to assign to the next participant
 Task skipCurrentAssignment(IWorkflowContext context, Task task)
          Skip current assignment and interpret the routing slip to assign to the next participant
 Task submitInfoForTask(IWorkflowContext context, Task task)
          Submit info to resume the task
 Task suspendTask(IWorkflowContext context, java.lang.String taskId)
          Suspend the task
 Task suspendTask(IWorkflowContext context, Task task)
          Suspend the task
 boolean suspendTasks(IWorkflowContext context, java.util.List taskIds)
          Suspend all the tasks identified by their task id in the specified list
 boolean updateOutcomeOfTasks(IWorkflowContext context, java.util.List taskIds, java.lang.String outcome)
          Set the outcome of all the tasks identified by their task id in the specified list
 Task updateTask(IWorkflowContext context, Task task)
          Update a task
 Task updateTaskOutcome(IWorkflowContext context, java.lang.String taskId, java.lang.String outcome)
          Set the outcome of the task
 Task updateTaskOutcome(IWorkflowContext context, Task task, java.lang.String outcome)
          Set the outcome of the task
 Task updateTaskOutcomeAndRoute(IWorkflowContext context, java.lang.String taskId, java.lang.String outcome, Participants participants)
          Set the outcome of the task and continue routing to the users and groups as specified in the list of IParticipant object
 Task updateTaskOutcomeAndRoute(IWorkflowContext context, Task task, java.lang.String outcome, Participants participants)
          Set the outcome of the task and continue routing to the users and groups as specified in the list of IParticipant object
 Task withdrawTask(IWorkflowContext context, java.lang.String taskId)
          Withdraw the task
 Task withdrawTask(IWorkflowContext context, Task task)
          Withdraw the task
 boolean withdrawTasks(IWorkflowContext context, java.util.List taskIds)
          Withdraw all the tasks identified by their task id in the specified list

 

Method Detail

initiateTask

public IInitiateTaskResponse initiateTask(Task task)
                                   throws StaleObjectException,
                                          WorkflowException
Initiate a task
Parameters:
task - The task object
Returns:
IInitiateTaskResponse The response from the initiate
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

reinitiateTask

public IInitiateTaskResponse reinitiateTask(Task task)
                                     throws StaleObjectException,
                                            WorkflowException
Reinitiate a task
Parameters:
task - The task object
Returns:
IInitiateTaskResponse The response from the reinitiate
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

overrideRoutingSlip

public Task overrideRoutingSlip(IWorkflowContext context,
                                Task task,
                                java.lang.String routingSlipURI)
                         throws StaleObjectException,
                                WorkflowException
Override current routing slip. The current assignment will be voided and the new routing slip will be evaluated for the new assignment and all the assignment henceforth
Parameters:
context - The IWorkflowContext
task - The task object
routingSlipURI - The URI for the new routing slip
Returns:
Task The task object after new assignment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

overrideRoutingSlip

public Task overrideRoutingSlip(IWorkflowContext context,
                                java.lang.String taskId,
                                java.lang.String routingSlipURI)
                         throws StaleObjectException,
                                WorkflowException
Override current routing slip. The current assignment will be voided and the new routing slip will be evaluated for the new assignment and all the assignment henceforth
Parameters:
context - The IWorkflowContext
taskId - The task id
routingSlipURI - The URI for the new routing slip
Returns:
Task The task object after new assignment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

skipCurrentAssignment

public Task skipCurrentAssignment(IWorkflowContext context,
                                  Task task)
                           throws StaleObjectException,
                                  WorkflowException
Skip current assignment and interpret the routing slip to assign to the next participant
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after skipping current assignment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

skipCurrentAssignment

public Task skipCurrentAssignment(IWorkflowContext context,
                                  java.lang.String taskId)
                           throws StaleObjectException,
                                  WorkflowException
Skip current assignment and interpret the routing slip to assign to the next participant
Parameters:
context - The IWorkflowContext
taskId - The task id
Returns:
Task The task object after skipping current assignment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateTask

public Task updateTask(IWorkflowContext context,
                       Task task)
                throws StaleObjectException,
                       WorkflowException
Update a task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after updating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

addComment

public Task addComment(IWorkflowContext context,
                       Task task,
                       java.lang.String comment)
                throws StaleObjectException,
                       WorkflowException
Add a comment
Parameters:
context - The IWorkflowContext
task - The task object
comment - The comment
Returns:
Task The task object after adding the comment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

addComment

public Task addComment(IWorkflowContext context,
                       java.lang.String taskId,
                       java.lang.String comment)
                throws StaleObjectException,
                       WorkflowException
Add a comment
Parameters:
context - The IWorkflowContext
taskId - The task id
comment - The comment
Returns:
Task The task object after adding the comment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

addAttachment

public Task addAttachment(IWorkflowContext context,
                          Task task,
                          AttachmentType attachment)
                   throws StaleObjectException,
                          WorkflowException
Add a attachment
Parameters:
context - The IWorkflowContext
task - The task object
attachment - The attachment object
Returns:
Task The task object after adding the attachment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

addAttachment

public Task addAttachment(IWorkflowContext context,
                          java.lang.String taskId,
                          AttachmentType attachment)
                   throws StaleObjectException,
                          WorkflowException
Add a attachment
Parameters:
context - The IWorkflowContext
taskId - The task id
attachment - The attachment object
Returns:
Task The task object after adding the attachment
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

removeAttachment

public Task removeAttachment(IWorkflowContext context,
                             java.lang.String taskId,
                             java.util.List attachmentNames)
                      throws StaleObjectException,
                             WorkflowException
Remove all task attachments identified by the list of attachment names
Parameters:
context - The IWorkflowContext
taskId - The task id
attachmentNames - List of attachment names
Returns:
Task The task object after removing attachments
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

removeAttachment

public Task removeAttachment(IWorkflowContext context,
                             Task task,
                             java.util.List attachmentNames)
                      throws StaleObjectException,
                             WorkflowException
Remove all task attachments identified by the list of attachment names
Parameters:
context - The IWorkflowContext
task - The task object
attachmentNames - List of attachment names
Returns:
Task The task object after removing attachments
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

mergeAndUpdateTask

public Task mergeAndUpdateTask(IWorkflowContext context,
                               Task task)
                        throws StaleObjectException,
                               WorkflowException
Merge and update a task. The task passed in to the method could be partial task, meaning, the task need not be complete. The attributes from this task will be merged into the same version of the task and updated. Note that payload is treated as one attribute, so if the payload in the input task is partial, it will overwrite the current payload with this partial payload.
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after escalating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

reassignTask

public Task reassignTask(IWorkflowContext context,
                         java.lang.String taskId,
                         java.util.List taskAssignees)
                  throws StaleObjectException,
                         WorkflowException
Reassign the task
Parameters:
context - The IWorkflowContext
taskId - The task id
taskAssignees - List of ITaskAssignee objects representing the users/groups to reassign the task to
Returns:
Task The task object after reassigning
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

reassignTask

public Task reassignTask(IWorkflowContext context,
                         Task task,
                         java.util.List taskAssignees)
                  throws StaleObjectException,
                         WorkflowException
Reassign the task
Parameters:
context - The IWorkflowContext
task - The task object
taskAssignees - List of ITaskAssignee objects representing the users/groups to reassign the task to
Returns:
Task The task object after reassigning
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

delegateTask

public Task delegateTask(IWorkflowContext context,
                         java.lang.String taskId,
                         java.util.List taskAssignees)
                  throws StaleObjectException,
                         WorkflowException
Delegate the task
Parameters:
context - The IWorkflowContext
taskId - The task id
taskAssignees - List of ITaskAssignee objects representing the users/groups to delegate the task to
Returns:
Task The task object after delegating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

delegateTask

public Task delegateTask(IWorkflowContext context,
                         Task task,
                         java.util.List taskAssignees)
                  throws StaleObjectException,
                         WorkflowException
Delegate the task
Parameters:
context - The IWorkflowContext
task - The task object
taskAssignees - List of ITaskAssignee objects representing the users/groups to delegate the task to
Returns:
Task The task object after delegating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

escalateTask

public Task escalateTask(IWorkflowContext context,
                         Task task)
                  throws StaleObjectException,
                         WorkflowException
Escalate the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after escalating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

escalateTask

public Task escalateTask(IWorkflowContext context,
                         java.lang.String taskId)
                  throws StaleObjectException,
                         WorkflowException
Escalate the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
Task The task object after escalating
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

renewTask

public Task renewTask(IWorkflowContext context,
                      Task task,
                      org.exolab.types.Duration duration)
               throws StaleObjectException,
                      WorkflowException
Renew the task
Parameters:
context - The IWorkflowContext
task - The task object
duration - The duration by which the task should be renewed
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

renewTask

public Task renewTask(IWorkflowContext context,
                      java.lang.String taskId,
                      org.exolab.types.Duration duration)
               throws StaleObjectException,
                      WorkflowException
Renew the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
duration - The duration by which the task should be renewed
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateTaskOutcome

public Task updateTaskOutcome(IWorkflowContext context,
                              Task task,
                              java.lang.String outcome)
                       throws StaleObjectException,
                              WorkflowException
Set the outcome of the task
Parameters:
context - The IWorkflowContext
task - The task object
outcome - The outcome of the task
Returns:
Task The task object after setting the outcome
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateTaskOutcome

public Task updateTaskOutcome(IWorkflowContext context,
                              java.lang.String taskId,
                              java.lang.String outcome)
                       throws StaleObjectException,
                              WorkflowException
Set the outcome of the task
Parameters:
context - The IWorkflowContext
taskId - The task id
outcome - The outcome of the task
Returns:
Task The task object after setting the outcome
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateOutcomeOfTasks

public boolean updateOutcomeOfTasks(IWorkflowContext context,
                                    java.util.List taskIds,
                                    java.lang.String outcome)
                             throws StaleObjectException,
                                    WorkflowException
Set the outcome of all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
taskIds - A list of task ids
outcome - The outcome of the task
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateTaskOutcomeAndRoute

public Task updateTaskOutcomeAndRoute(IWorkflowContext context,
                                      Task task,
                                      java.lang.String outcome,
                                      Participants participants)
                               throws StaleObjectException,
                                      WorkflowException
Set the outcome of the task and continue routing to the users and groups as specified in the list of IParticipant object
Parameters:
context - The IWorkflowContext
task - The task object
outcome - The outcome of the task
participants - The participants object. The participants contain individual participant types
Returns:
Task The task object after setting the outcome and routing
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

updateTaskOutcomeAndRoute

public Task updateTaskOutcomeAndRoute(IWorkflowContext context,
                                      java.lang.String taskId,
                                      java.lang.String outcome,
                                      Participants participants)
                               throws StaleObjectException,
                                      WorkflowException
Set the outcome of the task and continue routing to the users and groups as specified in the list of IParticipant object
Parameters:
context - The IWorkflowContext
taskId - The task id
outcome - The outcome of the task
participants - The participants object. The participants contain individual participant types
Returns:
Task The task object after setting the outcome and routing
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

withdrawTask

public Task withdrawTask(IWorkflowContext context,
                         Task task)
                  throws StaleObjectException,
                         WorkflowException
Withdraw the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after withdrawal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

withdrawTask

public Task withdrawTask(IWorkflowContext context,
                         java.lang.String taskId)
                  throws StaleObjectException,
                         WorkflowException
Withdraw the task
Parameters:
context - The IWorkflowContext
taskId - The task id
Returns:
Task The task object after withdrawal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

withdrawTasks

public boolean withdrawTasks(IWorkflowContext context,
                             java.util.List taskIds)
                      throws StaleObjectException,
                             WorkflowException
Withdraw all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
taskIds - A list of taskIds
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

suspendTask

public Task suspendTask(IWorkflowContext context,
                        Task task)
                 throws StaleObjectException,
                        WorkflowException
Suspend the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

suspendTask

public Task suspendTask(IWorkflowContext context,
                        java.lang.String taskId)
                 throws StaleObjectException,
                        WorkflowException
Suspend the task
Parameters:
context - The IWorkflowContext
taskId - The task id
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

suspendTasks

public boolean suspendTasks(IWorkflowContext context,
                            java.util.List taskIds)
                     throws StaleObjectException,
                            WorkflowException
Suspend all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
taskIds - A list of taskIds
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

resumeTask

public Task resumeTask(IWorkflowContext context,
                       Task task)
                throws StaleObjectException,
                       WorkflowException
Resume the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

resumeTask

public Task resumeTask(IWorkflowContext context,
                       java.lang.String taskId)
                throws StaleObjectException,
                       WorkflowException
Resume the task
Parameters:
context - The IWorkflowContext
taskId - The task id
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

resumeTasks

public boolean resumeTasks(IWorkflowContext context,
                           java.util.List taskIds)
                    throws StaleObjectException,
                           WorkflowException
Resume all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
taskIds - A list of taskIds
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

requestInfoForTask

public Task requestInfoForTask(IWorkflowContext context,
                               Task task,
                               ITaskAssignee taskAssignee)
                        throws StaleObjectException,
                               WorkflowException
Request for more information
Parameters:
context - The IWorkflowContext
task - The task object
taskAssignee - The task assignee to whom the request for info should be submitted
Returns:
Task The task object after marking as requested for more info
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

requestInfoForTask

public Task requestInfoForTask(IWorkflowContext context,
                               java.lang.String taskId,
                               ITaskAssignee taskAssignee)
                        throws StaleObjectException,
                               WorkflowException
Request for more information
Parameters:
context - The IWorkflowContext
taskId - The task Id
taskAssignee - The task assignee to whom the request for info should be submitted
Returns:
Task The task object after marking as requested for more info
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

requestInfoForTaskWithReapproval

public Task requestInfoForTaskWithReapproval(IWorkflowContext context,
                                             Task task,
                                             ITaskAssignee taskAssignee)
                                      throws StaleObjectException,
                                             WorkflowException
Request for more information and once the information is submitted, initiate reapproval from all the previous approvers since the user who submitted the information
Parameters:
context - The IWorkflowContext
task - The task object
taskAssignee - The task assignee to whom the request for info should be submitted
Returns:
Task The task object after marking as requested for more info
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

requestInfoForTaskWithReapproval

public Task requestInfoForTaskWithReapproval(IWorkflowContext context,
                                             java.lang.String taskId,
                                             ITaskAssignee taskAssignee)
                                      throws StaleObjectException,
                                             WorkflowException
Request for more information and once the information is submitted, initiate reapproval from all the previous approvers since the user who submitted the information
Parameters:
context - The IWorkflowContext
taskId - The task Id
taskAssignee - The task assignee to whom the request for info should be submitted
Returns:
Task The task object after marking as requested for more info
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

getUsersToRequestInfoForTask

public java.util.List getUsersToRequestInfoForTask(IWorkflowContext context,
                                                   Task task)
                                            throws StaleObjectException,
                                                   WorkflowException
Get the list of users from whom request for information can be requested
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
List List of user ids
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

getUsersToRequestInfoForTask

public java.util.List getUsersToRequestInfoForTask(IWorkflowContext context,
                                                   java.lang.String taskId)
                                            throws StaleObjectException,
                                                   WorkflowException
Get the list of users from whom request for information can be requested
Parameters:
context - The IWorkflowContext
taskId - The task id
Returns:
List List of user ids
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

submitInfoForTask

public Task submitInfoForTask(IWorkflowContext context,
                              Task task)
                       throws StaleObjectException,
                              WorkflowException
Submit info to resume the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after renewal
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

acquireTask

public Task acquireTask(IWorkflowContext context,
                        Task task)
                 throws StaleObjectException,
                        WorkflowException
Acquire the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after acquiring
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

acquireTask

public Task acquireTask(IWorkflowContext context,
                        java.lang.String taskId)
                 throws StaleObjectException,
                        WorkflowException
Acquire the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
Task The task object after acquiring
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

acquireTasks

public boolean acquireTasks(IWorkflowContext context,
                            java.util.List taskIds)
                     throws StaleObjectException,
                            WorkflowException
Acquire all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
Returns:
Task The task object after acquiring
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

releaseTask

public Task releaseTask(IWorkflowContext context,
                        Task task)
                 throws StaleObjectException,
                        WorkflowException
Release the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
Task The task object after acquiring
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

releaseTask

public Task releaseTask(IWorkflowContext context,
                        java.lang.String taskId)
                 throws StaleObjectException,
                        WorkflowException
Release the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
Task The task object after releasing it
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

releaseTasks

public boolean releaseTasks(IWorkflowContext context,
                            java.util.List taskIds)
                     throws StaleObjectException,
                            WorkflowException
Release all the tasks identified by their task id in the specified list
Parameters:
context - The IWorkflowContext
Returns:
Task The task object after acquiring
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

routeTask

public Task routeTask(IWorkflowContext context,
                      java.lang.String taskId,
                      Participants participants)
               throws StaleObjectException,
                      WorkflowException
Route the task to the specified participant. The task will not come back to the the user who is routing it. If the task should come back to the current user, the user has to add a simple participant to the list
Parameters:
context - The IWorkflowContext
taskId - The task Id
participants - The participants object. The participants contain individual participant types
Returns:
Task The task object after routing it
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

routeTask

public Task routeTask(IWorkflowContext context,
                      Task task,
                      Participants participants)
               throws StaleObjectException,
                      WorkflowException
Route the task to the specified participant. The task will not come back to the the user who is routing it. If the task should come back to the current user, the user has to add a simple participant to the list
Parameters:
context - The IWorkflowContext
task - The task
participants - The participants object. The participants contain individual participant types
Returns:
Task The task object after routing it
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

pushBackTask

public Task pushBackTask(IWorkflowContext context,
                         java.lang.String taskId)
                  throws StaleObjectException,
                         WorkflowException
PushBack the task to the previous approver/original assignees. Whether the task would be pushed back to the approver/original assignees is determined by the configuration property. After the pushed back user participates the task will be routed to the user who pushed back.
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
Task The task object after pushing back
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

pushBackTask

public Task pushBackTask(IWorkflowContext context,
                         Task task)
                  throws StaleObjectException,
                         WorkflowException
PushBack the task to the previous approver/original assignees. Whether the task would be pushed back to the approver/original assignees is determined by the configuration property. After the pushed back user participates the task will be routed to the user who pushed back.
Parameters:
context - The IWorkflowContext
task - The task
Returns:
Task The task object after pushing back
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

errorTask

public Task errorTask(IWorkflowContext context,
                      Task task)
               throws StaleObjectException,
                      WorkflowException
Error the task
Parameters:
context - The IWorkflowContext
Returns:
Task The task object after erroring it
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

errorTask

public Task errorTask(IWorkflowContext context,
                      java.lang.String taskId)
               throws StaleObjectException,
                      WorkflowException
Error the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
Task The task object after erroring it
Throws:
StaleObjectException - This Exception is thrown when the object is modified since it was retrieved by this caller
WorkflowException - Any other exception encountered by the task manager

getApprovers

public java.util.List getApprovers(IWorkflowContext context,
                                   Task task)
                            throws WorkflowException
Get all the approvers of the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
List List of approvers. Each entry in the list is a String identifying the user
Throws:
WorkflowException - Any other exception encountered by the task manager

getApprovers

public java.util.List getApprovers(IWorkflowContext context,
                                   java.lang.String taskId)
                            throws WorkflowException
Get all the approvers of the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
List List of approvers. Each entry in the list is a String identifying the user
Throws:
WorkflowException - Any other exception encountered by the task manager

getFutureParticipants

public RoutingSlip getFutureParticipants(IWorkflowContext context,
                                         java.lang.String taskId)
                                  throws WorkflowException
Get all the future participants for the task
Parameters:
context - The IWorkflowContext
taskId - The task Id
Returns:
RoutingSlip The resolved routing slip that contains the future participants
Throws:
WorkflowException - Any other exception encountered by the task manager

getFutureParticipants

public RoutingSlip getFutureParticipants(IWorkflowContext context,
                                         Task task)
                                  throws WorkflowException
Get all the future participants for the task
Parameters:
context - The IWorkflowContext
task - The task object
Returns:
RoutingSlip The resolved routing slip that contains the future participants
Throws:
WorkflowException - Any other exception encountered by the task manager

Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle BPEL Process Manager
Workflow Services API Reference
10g Release 3 (10.1.3)
B28985-02
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006, Oracle. All rights reserved.