Interface BpmServiceLocal
public interface BpmServiceLocal
-
Method Summary
Modifier and TypeMethodDescriptiongetProcessInstanceState(String processInstanceId) Checks the state of a Process Instance.getTaskList(String firstResult, String maxResults, TaskQueryDto taskQuery) getUnfinishedActivityInstancesByDocumentId(String documentId) Fetches unfinished Activity Instances for a given parameter.getUnfinishedActivityInstancesByProcessInstanceId(String processInstanceId) Fetches unfinished Activity Instances for a given parameter.getUnfinishedActivityInstancesByPublicationId(String publicationId) Fetches unfinished Activity Instances for a given parameter.startProcessInstance(String key, String businessKey, Map<String, TypedVariable> variables) Creates a new process instance and begins its execution.
-
Method Details
-
getTaskList
- Parameters:
firstResult- - index of first returnedCustomTaskfrom all which were found by BPMmaxResults- - number of returnedCustomTaskfrom all which were found by BPMtaskQuery- see:TaskQueryDto- Returns:
ListofCustomTaskfrom BPM
-
getProcessDefinitionList
List<ProcessDefinition> getProcessDefinitionList()- Returns:
ListofProcessDefinitionfrom BPM
-
getProcessDefinitionByKey
- Parameters:
key- -String- Returns:
ProcessDefinitionfrom 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 definitionbusinessKey- 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:
ProcessInstancedescribing the newly created process instance.
-
getProcessInstanceState
Checks the state of a Process Instance. -
getUnfinishedActivityInstancesByDocumentId
Fetches unfinished Activity Instances for a given parameter.- Parameters:
documentId- id of the document for which processes got started.- Returns:
ActivityInstancesListingcontaining unfinished Camunda Activity Instances for this document.
-
getUnfinishedActivityInstancesByPublicationId
Fetches unfinished Activity Instances for a given parameter.- Parameters:
publicationId- id of the publication for which processes got started.- Returns:
ActivityInstancesListingcontaining 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:
ActivityInstancesListingcontaining unfinished Camunda Activity Instances for this process instance.
-