Package oracle.bpel.services.workflow.task

Interface ITaskService

public interface ITaskService

  • Method Details

    • initiateTask

      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

    • initiateTask

      IInitiateTaskResponse initiateTask(Task task, RoutingSlip routingSlip) throws StaleObjectException, WorkflowException
      Initiate a task
      Parameters:
      task - The task object
      routingSlip - The new routing slip
      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

      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

    • restartRootTask

      IInitiateTaskResponse restartRootTask(IWorkflowContext wfctx, oracle.bpel.services.workflow.task.IRestartContext restartContext, Task task) throws StaleObjectException, WorkflowException
      Restarts a root task
      This API is available only if Approval Management Extension is enabled
      Parameters:
      wfctx - - Workflow Context
      restartContext - - Restart Context
      task - - Current approval task. Note: "task" parameter passed to this method must be a root task
      Returns:
      - IInitiateTaskResponse
      Throws:
      StaleObjectException
      WorkflowException

    • prepareForRestartRootTask

      Task prepareForRestartRootTask(IWorkflowContext wfctx, oracle.bpel.services.workflow.task.IRestartContext restartContext, Task task) throws StaleObjectException, WorkflowException
      Prepares for restarting a root Task If PreserveAdhocInsertion is set to true in restartContext, Then all the TaskSequenceChange records corresponding to oldCorrelationdId are duplicated with correlationid set to newCorrelationId
      This API is available only if Approval Management Extension is enabled
      Parameters:
      wfctx - - WorkflowContext
      restartContext - - RestartContext
      task - - Current root task
      Returns:
      Task - a new Task Instance . This task should be used as input for Approval List Editing UI for showing approval hierarchy preview for to-be restarted task.
      Throws:
      StaleObjectException
      WorkflowException

    • createToDoTask

      Task createToDoTask(IWorkflowContext context, Task task, List taskAssignees, String parentTaskId) throws StaleObjectException, WorkflowException
      Create a todo task
      Parameters:
      context - an IWorkflowContext value
      task - a Task value
      taskAssignees - The list of users/groups to whom the task should be assigned
      parentTaskId - The parent task id if creating the todo task as part of another task
      Returns:
      a Task value
      Throws:
      StaleObjectException - if an error occurs
      WorkflowException - if an error occurs

    • overrideRoutingSlip

      Task overrideRoutingSlip(IWorkflowContext context, Task task, 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

      Task overrideRoutingSlip(IWorkflowContext context, String taskId, 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

      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

      Task skipCurrentAssignment(IWorkflowContext context, 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

      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

      Task addComment(IWorkflowContext context, Task task, 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

      Task addComment(IWorkflowContext context, Task task, CommentType comment) throws StaleObjectException, WorkflowException
      Add a comment
      Parameters:
      context - The IWorkflowContext
      task - The task object
      comment - The comment . Scope can be set in comment object. If not set the default scope of comment is TASK.
      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

      Task addComment(IWorkflowContext context, String taskId, 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

    • addComment

      Task addComment(IWorkflowContext context, String taskId, String comment, String rejectionReasons) throws StaleObjectException, WorkflowException
      Add a comment and rejectionreasons
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      comment - The comment
      rejectionReasons - The rejectionreasons
      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

    • addCommentToTasks

      boolean addCommentToTasks(IWorkflowContext context, List taskIds, String comment) throws StaleObjectException, WorkflowException
      Add a comment to multiple tasks
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids
      comment - 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

    • addCommentToTasks

      boolean addCommentToTasks(IWorkflowContext context, List taskIds, CommentType comment) throws StaleObjectException, WorkflowException
      Add a comment to multiple tasks
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids
      comment - The comment.Scope can be set in comment object. If not set the default scope of comment is 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

    • updateTaskOutcome

      Task updateTaskOutcome(IWorkflowContext context, String taskId, String outcome, CommentType comment) throws StaleObjectException, WorkflowException
      Set the outcome of the task
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      outcome - The outcome of the task
      comment - The comment for updating 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

      boolean updateOutcomeOfTasks(IWorkflowContext context, List taskIds, String outcome, CommentType comment) 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
      comment - The comment for updating 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

    • addAttachment

      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

      Task addAttachment(IWorkflowContext context, 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

      Task removeAttachment(IWorkflowContext context, String taskId, 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

      Task removeAttachment(IWorkflowContext context, Task task, 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

    • addDocument

      Task addDocument(IWorkflowContext context, Task task, DocumentType document) throws StaleObjectException, WorkflowException
      Add a document
      Parameters:
      context - The IWorkflowContext
      task - The task object
      document - The document object
      Returns:
      Task The task object after adding the document
      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

    • addDocument

      Task addDocument(IWorkflowContext context, String taskId, DocumentType document) throws StaleObjectException, WorkflowException
      Add a document
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      document - The document object
      Returns:
      Task The task object after adding the document
      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

    • removeDocument

      Task removeDocument(IWorkflowContext context, String taskId, List documentNames) throws StaleObjectException, WorkflowException
      Remove all task documents identified by the list of document names
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      documentNames - List of document names
      Returns:
      Task The task object after removing documents
      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

    • removeDocument

      Task removeDocument(IWorkflowContext context, Task task, List documentNames) throws StaleObjectException, WorkflowException
      Remove all task documents identified by the list of document names
      Parameters:
      context - The IWorkflowContext
      task - The task object
      documentNames - List of document names
      Returns:
      Task The task object after removing documents
      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

      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

      Task reassignTask(IWorkflowContext context, String taskId, 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

      Task reassignTask(IWorkflowContext context, Task task, 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

    • reassignTasks

      boolean reassignTasks(IWorkflowContext context, List taskIds, List taskAssignees) throws StaleObjectException, WorkflowException
      Reassign all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      taskAssignees - List of ITaskAssignee objects representing the users/groups to reassign the task to
      Returns:
      boolean true if successful, false otherwise
      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

      Task delegateTask(IWorkflowContext context, String taskId, 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

      Task delegateTask(IWorkflowContext context, Task task, 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

    • delegateTasks

      boolean delegateTasks(IWorkflowContext context, List taskIds, List taskAssignees) throws StaleObjectException, WorkflowException
      Delegate all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext,
      taskIds - The list of task ids (can be comma seperated strings).
      taskAssignees - List of ITaskAssignee objects representing the users/groups to delegate the task to
      Returns:
      boolean true if successful, false otherwise
      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

    • reevaluateTask

      boolean reevaluateTask(IWorkflowContext context, String taskId, ITaskAssignee reorgedUser) throws StaleObjectException, WorkflowException
      Re-evaluate the task
      This API is available only if Approval Management Extension is enabled
      Parameters:
      context - The IWorkflowContext
      taskId - The task Id
      reorgedUser - User who is re-orged in the organization
      Returns:
      boolean true if successful, false otherwise
      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

      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

      Task escalateTask(IWorkflowContext context, 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

    • escalateTasks

      boolean escalateTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Escalate all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      Returns:
      boolean true if successful, false otherwise
      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

      Task renewTask(IWorkflowContext context, Task task, 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

      Task renewTask(IWorkflowContext context, String taskId, 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

      Task updateTaskOutcome(IWorkflowContext context, Task task, 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

      Task updateTaskOutcome(IWorkflowContext context, String taskId, 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

      boolean updateOutcomeOfTasks(IWorkflowContext context, List taskIds, 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

      Task updateTaskOutcomeAndRoute(IWorkflowContext context, Task task, 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

      Task updateTaskOutcomeAndRoute(IWorkflowContext context, String taskId, 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

      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

      Task withdrawTask(IWorkflowContext context, Task task, boolean skipCallback) throws StaleObjectException, WorkflowException
      Withdraw the task
      Parameters:
      context - The IWorkflowContext
      task - The task object
      skipCallback - if true then skip callbacks
      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

      Task withdrawTask(IWorkflowContext context, String taskId, boolean skipCallback) throws StaleObjectException, WorkflowException
      Withdraw the task
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      skipCallback - if true then skip callbacks
      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

      Task withdrawTask(IWorkflowContext context, 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

      boolean withdrawTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Withdraw all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

      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

      Task suspendTask(IWorkflowContext context, 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

      boolean suspendTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Suspend all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

      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

      Task resumeTask(IWorkflowContext context, 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

      boolean resumeTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Resume all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

      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

      Task requestInfoForTask(IWorkflowContext context, 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

      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

      Task requestInfoForTaskWithReapproval(IWorkflowContext context, 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

      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

      List getUsersToRequestInfoForTask(IWorkflowContext context, 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

      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

      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

      Task acquireTask(IWorkflowContext context, 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

      boolean acquireTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Acquire all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

    • deleteTask

      Task deleteTask(IWorkflowContext context, Task task) throws StaleObjectException, WorkflowException
      Delete the task. This performs a logical delete of this task any sub tasks it has. To perform a delete from the data store, please use the purgeTask API.
      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

    • deleteTask

      Task deleteTask(IWorkflowContext context, String taskId) throws StaleObjectException, WorkflowException
      Delete the task. This performs a logical delete of this task any sub tasks it has. To perform a delete from the data store, please use the purgeTask API.
      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

    • deleteTasks

      boolean deleteTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Delete all the tasks identified by their task id in the specified list. This performs a logical delete of this task any sub tasks it has. To perform a delete from the data store, please use the purgeTask API.
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

    • purgeTask

      boolean purgeTask(IWorkflowContext context, Task task) throws StaleObjectException, WorkflowException
      Purge the task. This deletes the task and its subtasks in the data store. To perform a logical delete, use the deleteTask API
      Parameters:
      context - The IWorkflowContext
      task - The task object
      Returns:
      a boolean value. True indicates success
      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

    • purgeTask

      boolean purgeTask(IWorkflowContext context, String taskId) throws StaleObjectException, WorkflowException
      Purge the task. This deletes the task and its subtasks in the data store. To perform a logical delete, use the deleteTask API
      Parameters:
      context - The IWorkflowContext
      taskId - The task Id
      Returns:
      a boolean value. True indicates success
      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

    • purgeTasks

      boolean purgeTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Purge all the tasks identified by their task id in the specified list. This deletes the task and its subtasks in the data store. To perform a logical delete, use the deleteTask API
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

      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

      Task releaseTask(IWorkflowContext context, 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

      boolean releaseTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Release all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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

      Task routeTask(IWorkflowContext context, 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

      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

      Task pushBackTask(IWorkflowContext context, 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

      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

      Task errorTask(IWorkflowContext context, Task task) 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

    • errorTask

      Task errorTask(IWorkflowContext context, 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

      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

      List getApprovers(IWorkflowContext context, 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

      RoutingSlip getFutureParticipants(IWorkflowContext context, 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

      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

    • setTaskSequenceChanges

      int setTaskSequenceChanges(IWorkflowContext context, Task task, List<oracle.bpel.services.workflow.common.tsc.model.TaskSequenceChange> taskSequenceChanges, boolean reset) throws WorkflowException, StaleObjectException
      Set the sequence changes for the task
      Parameters:
      context - The IWorkflowContext
      task - The task object
      taskSequenceChanges - List of TaskSequenceChange objects for the task instance
      reset - reseti flag to reset all changes to null, List is ignored if not null.
      Returns:
      void
      Throws:
      WorkflowException - Any other exception encountered by the task manager
      StaleObjectException

    • updatePriority

      void updatePriority(IWorkflowContext context, String taskId, ITaskService.UpdatePriorityType updateType, int priority) throws StaleObjectException, WorkflowException
      Update the priority of the task and its subtasks for the given taskId. If UpdatePriorityType is INCREMENT then the task will be updated by incrementing the given priority by 1(i.e the priority of the task will be lowered). If the UpdatePriorityType is DECREMENT then the task will be updated by decrementing the priority by 1(i.e the priority of the task will be increased), otherwise the task will be updated with the given priority.
      Parameters:
      context - The IWorkflowContext
      taskId - the task id of the task to be updated
      updateType - can be of three values INCREMENT/DECRMENT/UPDATE
      priority - the priority to be considered if the UpdatePriorityType is UPDATE. Will be ignored otherwise.
      Throws:
      StaleObjectException
      WorkflowException

    • updatePriorityOfTasks

      void updatePriorityOfTasks(IWorkflowContext context, List taskIds, ITaskService.UpdatePriorityType updateType, int priority) throws StaleObjectException, WorkflowException
      Update the priority of the task and its subtasks for the given taskIds List. If UpdatePriorityType is INCREMENT then the task will be updated by incrementing the given priority by 1(i.e the priority of the task will be lowered). If the UpdatePriorityType is DECREMENT then the task will be updated by decrementing the priority by 1(i.e the priority of the task will be increased), otherwise the task will be updated with the given priority.
      Parameters:
      context - The IWorkflowContext
      updateType - can be of three values INCREMENT/DECRMENT/UPDATE
      priority - the priority to be considered if the UpdatePriorityType is UPDATE. Will be ignored otherwise.
      taskIds - The list of task ids (can be comma seperated strings).
      Throws:
      StaleObjectException
      WorkflowException

    • suspendTimers

      void suspendTimers(IWorkflowContext context, Task task) throws StaleObjectException, WorkflowException
      Suspend ALL the timers on a specific task and its subtasks/aggregated tasks. All the timers ie reminders, notifications, auto release timers will be turned off untill the resumeTimers api is called. This api helps in gaining buffer time on the task. Note that this api has no effect on the task state or outcome. When timers are suspended, we do not start any new timers on the task and pause all the existing timers. This api can only be used by only admin or task owner.
      Parameters:
      context - The IWorkflowContext
      task - task object
      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

    • suspendTimers

      void suspendTimers(IWorkflowContext context, String taskId) throws StaleObjectException, WorkflowException
      Suspend ALL the timers on a specific task and its subtasks/aggregated tasks. All the timers ie reminders, notifications, auto release timers will be turned off untill the resumeTimers api is called. This api helps in gaining buffer time on the task. Note that this api has no effect on the task state or outcome. When timers are suspended, we do not start any new timers on the task and pause all the existing timers This api can only be used by only admin or task owner.
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      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

    • resumeTimers

      void resumeTimers(IWorkflowContext context, Task task) throws StaleObjectException, WorkflowException
      Resume ALL timers on a specific task and its subtasks/aggregated tasks. All the timers ie reminders, notifications, auto release timers will be turned back on, which are turned off when the suspendTimers api is called. This api should be called only in conjunction with suspendTimers call. Note that this api has no effect on the task state or outcome. Timers resume from the exact same point when they are suspended using suspendTimers api. This api can only be used by only admin or task owner.
      Parameters:
      context - The IWorkflowContext
      task - task object
      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

    • resumeTimers

      void resumeTimers(IWorkflowContext context, String taskId) throws StaleObjectException, WorkflowException
      Resume ALL timers on a specific task and its subtasks/aggregated tasks. All the timers ie reminders, notifications, will be turned back on, which are turned off when the suspendTimers api is called. This api should be called only in conjunction with suspendTimers call. Note that this api has no effect on the task state or outcome. Timers resume from the exact same point when they are suspended using suspendTimers api. This api can only be used by only admin or task owner.
      Parameters:
      context - The IWorkflowContext
      taskId - The task id
      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

    • decomposeTask

      Task decomposeTask(IWorkflowContext context, String taskId, RoutingSlip routingSlip, DecomposeTaskInfo decomposeTaskInfo) throws StaleObjectException, WorkflowException
      Decompose the specified Task given by taskId into constituent tasks based on the RoutingSlip and DecomposeTaskInfo objects.
      Parameters:
      context - - The IWorkflowContext
      taskId - - The task Id of the original task that needs to be decomposed
      routingSlip - - The routing slip used to decompose the task specified by taskId
      decomposeTaskInfo - - The decomposeTaskInfo object
      Returns:
      Task The task object after it was decomposed
      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

    • updateTasksByCommands

      oracle.bpel.services.workflow.task.command.model.TasksUpdateByCommandsResponse updateTasksByCommands(IWorkflowContext context, List<String> taskIds, oracle.bpel.services.workflow.task.command.model.TasksUpdateByCommands command) throws StaleObjectException, WorkflowException
      Perform a series of task update commands. One task at a time, all non-state-change commands are executed in one transaction first, and state-change command are executed in another transaction after that.The integrity of multiple update operations are done according to the following policy:
      1. If one of the non-state-change commands failed when updating a specific task, all of the non-state-change operations for that task will be aborted and the state-change command will be skipped for that specific task. The update operations will continue for the remaining tasks in the list.
      2. If all non-state-change commands for a task are executed successfully but the state-change command failed, all of the non-state-change commands will go through and only the state-change command will be rolled back. Meaning that, this particular task will not change its original state.
      Parameters:
      context - - The IWorkflowContext
      taskIds - - The list of task ids
      comamnd - -TasksUpdateByCommands Jaxb object
      Returns:
      TasksUpdateByCommandsResponse Return only the status of tasks which are failed to be updated.
      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

    • updateArchivedOnValueForTasks

      void updateArchivedOnValueForTasks(IWorkflowContext context, List<String> taskIds) throws WorkflowException
      Update the ARCHIVEDON column with the current timestamp for the given list of taskIds.
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      Throws:
      WorkflowException

    • reassignView

      UserViewDetail reassignView(IWorkflowContext context, String viewId, String newViewOwner, String viewOwnerType, List taskAssignees) throws StaleObjectException, WorkflowException
      Reassign the View
      Parameters:
      context - The IWorkflowContext
      viewId - The view id
      newViewOwner - user/group to reassign the view to
      viewOwnerType - user type(Either user/group)
      taskAssignees - List of ITaskAssignee objects representing the users/groups to reassign the view's task to
      Returns:
      UserViewDetail The view 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

    • deleteView

      UserViewDetail deleteView(IWorkflowContext context, String viewId) throws StaleObjectException, WorkflowException
      Delete the view.
      Parameters:
      context - The IWorkflowContext
      viewId - The view Id
      Returns:
      UserViewDetail The view 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

    • addComment

      Task addComment(IWorkflowContext context, String taskId, CommentType comment) throws StaleObjectException, WorkflowException
      Add a comment
      Parameters:
      context - The IWorkflowContext
      taskId - String representing the task ID
      comment - The CommentType object capturing all the comment details
      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

    • updateTaskOutcomeAsync

      void updateTaskOutcomeAsync(IWorkflowContext context, String taskId, String outcome) throws StaleObjectException, WorkflowException
      Method execution:
    • 1. Perform preaction validation
    • 2. Schedule Task Operation for updateTaskOutcome
      • Parameters:
      context - The IWorkflowContext
      taskId - The task id
      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

    • updateTaskOutcomeAsync

      void updateTaskOutcomeAsync(IWorkflowContext context, Task task, String outcome) throws StaleObjectException, WorkflowException
      Method execution:
    • 1. Perform preaction validation
    • 2. Schedule Task Operation for updateTaskOutcome
      • Parameters:
      context - The IWorkflowContext
      task - The task object
      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

    • revertLastAction

      void revertLastAction(IWorkflowContext ctx, String flowInstanceGuid, Map params) throws WorkflowException
      revert the last user action
      Parameters:
      ctx - The IWorkflowContext
      flowInstanceGuid - id of the flow to be aborted
      params -
      Throws:
      WorkflowException

    • replayLastAction

      void replayLastAction(IWorkflowContext ctx, String flowInstanceGuid, Map params) throws WorkflowException
      replay the last user action
      Parameters:
      ctx - The IWorkflowContext
      flowInstanceGuid - id of the flow to be restarted
      params -
      Throws:
      WorkflowException

    • resumeFlow

      void resumeFlow(IWorkflowContext ctx, String flowInstanceGuid, Map params) throws WorkflowException
      resume a flow
      Parameters:
      ctx - The IWorkflowContext
      flowInstanceGuid - lowInstanceGuid id of the flow to be resumed
      params -
      Throws:
      WorkflowException

    • addParticipantsInParallel

      boolean addParticipantsInParallel(IWorkflowContext context, String subTaskId, Participants participants) throws StaleObjectException, WorkflowException
      Adds new participants in parallel to the participant corresponding to the subtask id
      Parameters:
      context - The IWorkflowContext
      subTaskId - The task Id
      participants - The participants object. The participants contain individual participant types
      Returns:
      True if new participants are added successfully. Else return false.
      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

    • renewTasks

      boolean renewTasks(IWorkflowContext context, List taskIds) throws StaleObjectException, WorkflowException
      Renew all the tasks identified by their task id in the specified list
      Parameters:
      context - The IWorkflowContext
      taskIds - The list of task ids (can be comma seperated strings).
      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