Interface WorkflowInstanceCollectionResponse


public interface WorkflowInstanceCollectionResponse
Holds a list of WorkflowInstances.
  • Method Details

    • getWorkflowInstance

      WorkflowInstance getWorkflowInstance(String workflowId)
      Given the workflow ID, obtains the WorkflowInstance. This value is never null.
      Parameters:
      workflowId - ID of the workflow. Cannot be null or empty. Workflow ID must exist. For example, 100.
      Returns:
      the WorkflowInstance for this workflow
    • containsWorkflowInstance

      boolean containsWorkflowInstance(String workflowId)
      Given the workflow ID, checks to see if a WorkflowInstance exists with the ID.
      Parameters:
      workflowId - ID of the workflow. Cannot be null or empty. Workflow ID must exist. For example, 100.
      Returns:
      true if the instance exists, otherwise false
    • getWorkflowInstances

      List<WorkflowInstance> getWorkflowInstances()
      Retrieve a list of WorkflowInstance.
      Returns:
      a list of all the WorkflowInstance