Package com.aquima.interactions.process

Interface IProcessData

All Known Subinterfaces:
IProcessEngine
All Known Implementing Classes:
ProcessEngine, ProcessEngineDelegate, ReadonlyProcessEngine
public interface IProcessData

  • Method Details

    • getTask

      IProcessTask getTask(long taskId)
      This method returns the task for the specified ID.
      Parameters:
      taskId - The ID of the requested task.
      Returns:
      The task for the specified ID.
      Throws:
      UnknownProcessTaskException - This exception is thrown when the task could not be found.

    • getTaskModel

      ITaskModel getTaskModel(long taskId)
      This method returns the task for the specified ID.
      Parameters:
      taskId - The ID of the requested task.
      Returns:
      The task for the specified ID.
      Throws:
      UnknownProcessTaskException - This exception is thrown when the task could not be found.

    • getAvailableTasks

      IProcessTask[] getAvailableTasks(IUserData userData, Long caseId)
      This method returns an array containing the tasks that are available for the supplied user. This method is also known as the "tasks for me" in the documentation.
      Parameters:
      userData - The data of the user to which the task must be assigned.
      caseId - ID of the case to which the tasks must belong.
      Returns:
      an array containing the tasks for the supplied user.

    • getUnassignedTasks

      IProcessTask[] getUnassignedTasks()
      This method returns an array containing all the tasks that have not yet been assigned.
      Returns:
      an array containing all the tasks that have not yet been assigned.

    • findTasks

      IProcessTaskView[] findTasks(TaskCriteria taskFilter)
      This method returns an array containing views of all tasks that are valid after applying the filters from the filter context.
      Parameters:
      taskFilter - TaskFilterContext to filter the tasks that are returned.
      Returns:
      an array containing the task views.

    • findCases

      IProcessCaseView[] findCases(CaseCriteria caseFilter)
      This method returns an array containing views of all cases that are valid after applying the filters from the filter context
      Parameters:
      caseFilter - CaseFilterContext to filter the cases that are returned.
      Returns:
      an array containing the case views

    • getAvailableCases

      IProcessCase[] getAvailableCases(IUserData userData)
      This method will return an array containing the cases that are available for the supplied user.
      Parameters:
      userData - Object containing the information about the current user.
      Returns:
      an array containing the cases that are available for the supplied user.

    • getCase

      IProcessCase getCase(long caseId)
      This method returns the case for the specified ID.
      Parameters:
      caseId - The ID of the requested case.
      Returns:
      The case for the specified ID.
      Throws:
      UnknownProcessCaseException - This exception is thrown when the case could not be found.

    • findWaitingCases

      ICaseModel[] findWaitingCases(String messageEventName, Set<Long> specificCaseIds)
      This method returns the cases waiting for a message event.
      Parameters:
      messageEventName - The message event name, may not be null.
      specificCaseIds - A set of case ids, may be null. If not null, only those cases are processed.
      Returns:
      The case models waiting for the message event.

    • findByCriteria

      TaskViewResult findByCriteria(TaskViewCriteria criteria)
      Find task views based on the specified criteria.

      This method alters the criteria by enabling or disabling checking for restriced users depending on the ignore mode setting of the criteria and on whether any authorization algorithms use the 2-man rule. If the Application ID is not ignored, and no authorization algorithm in this process engine uses the 2-man rule, then checking for restricted users is disabled.

      For an equivalent method which does not alter the criteria, see IProcessCaseDao.findByCriteria(TaskViewCriteria).

      Parameters:
      criteria - the task criteria to search for
      Returns:
      TaskViewResult the tasks matching the criteria

    • findByCriteria

      CaseViewResult findByCriteria(CaseViewCriteria criteria)
      Find case views based on the specified criteria.
      Parameters:
      criteria - the case criteria to search for
      Returns:
      CaseViewResult the cases matching the criteria

    • getCaseState

      ICaseStateModel getCaseState(long caseId)
      Gets the case state
      Parameters:
      caseId - the case ID
      Returns:
      the case state