Package com.priint.pubserver.bpm.interfaces

Interface BpmServiceLocal

  • public interface BpmServiceLocal

    • Method Detail

      • getTaskList

        java.util.List<CustomTask> getTaskList​(java.lang.String firstResult,
                                       java.lang.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

      • startProcessInstance

        ProcessInstance startProcessInstance​(java.lang.String key,
                                     java.lang.String businessKey,
                                     java.util.Map<java.lang.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

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

      • getUnfinishedActivityInstancesByDocumentId

        ActivityInstancesListing getUnfinishedActivityInstancesByDocumentId​(java.lang.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​(java.lang.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​(java.lang.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.