Interface BpmServiceLocal


public interface BpmServiceLocal
  • Method Details

    • getTaskList

      List<CustomTask> getTaskList(String firstResult, String maxResults, TaskQueryDto taskQuery)
      Parameters:
      firstResult - - index of first returned CustomTask from all which were found by BPM
      maxResults - - number of returned CustomTask from all which were found by BPM
      taskQuery - see: TaskQueryDto
      Returns:
      List of CustomTask from BPM
    • getProcessDefinitionList

      List<ProcessDefinition> getProcessDefinitionList()
      Returns:
      List of ProcessDefinition from BPM
    • getProcessDefinitionByKey

      ProcessDefinition getProcessDefinitionByKey(String key)
      Parameters:
      key - - String
      Returns:
      ProcessDefinition from BPM
    • startProcessInstance

      ProcessInstance startProcessInstance(String key, String businessKey, Map<String,TypedVariable> variables)
      Creates a new process instance and begins its execution.
      Parameters:
      key - identifier of the process definition
      businessKey - business key that should be assigned to the process instance. It is ID of document, publication, planning etc., depending on objectType (see objectType in variables).
      variables - a variable-name -> variable-value-with-its-type map that will be set in process instance context as its variables. Variables required to run process: tenant, project, login, objectType (DOCUMENT, PUBLICATION, FOLDER, FOLDER_PUBLICATION, PLANNING, PAGE, REAL_GRID_ELEMENT, GENERAL). Additional variables required to run process for objectType equals "PLANNING": sessionId, entityModelIdentifier. If a process is run from another (parent) process, the variables can be used from the parent process.
      Returns:
      ProcessInstance describing the newly created process instance.
    • getProcessInstanceState

      Optional<String> getProcessInstanceState(String processInstanceId)
      Checks the state of a Process Instance.
      Parameters:
      processInstanceId - identifier of the process instance.
      Returns:
      Optional<String> containing a Camunda state of the process instance.
    • getUnfinishedActivityInstancesByDocumentId

      ActivityInstancesListing getUnfinishedActivityInstancesByDocumentId(String documentId)
      Fetches unfinished Activity Instances for a given parameter.
      Parameters:
      documentId - id of the document for which processes got started.
      Returns:
      ActivityInstancesListing containing unfinished Camunda Activity Instances for this document.
    • getUnfinishedActivityInstancesByPublicationId

      ActivityInstancesListing getUnfinishedActivityInstancesByPublicationId(String publicationId)
      Fetches unfinished Activity Instances for a given parameter.
      Parameters:
      publicationId - id of the publication for which processes got started.
      Returns:
      ActivityInstancesListing containing unfinished Camunda Activity Instances for this publication.
    • getUnfinishedActivityInstancesByProcessInstanceId

      ActivityInstancesListing getUnfinishedActivityInstancesByProcessInstanceId(String processInstanceId)
      Fetches unfinished Activity Instances for a given parameter.
      Parameters:
      processInstanceId - identifier of the process instance.
      Returns:
      ActivityInstancesListing containing unfinished Camunda Activity Instances for this process instance.