Package org.activiti.api.process.runtime

Interface ProcessRuntime

public interface ProcessRuntime

  • Method Summary

    Modifier and Type
    Method
    Description
    ProcessRuntimeConfiguration
    configuration()
    Returns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listeners
    org.activiti.api.process.model.ProcessInstance
    create(org.activiti.api.process.model.payloads.CreateProcessInstancePayload startProcessPayload)
    Create a new Process Instance based on the payload parameters
    org.activiti.api.process.model.ProcessInstance
    delete(org.activiti.api.process.model.payloads.DeleteProcessPayload deleteProcessPayload)
    Delete a Process Instance
    org.activiti.api.process.model.ProcessDefinition
    processDefinition(String processDefinitionId)
    Get process definition by key or id (where the ID is autogenerated at deployment time)
    org.activiti.api.process.model.ProcessDefinitionMeta
    processDefinitionMeta(String processDefinitionKey)
     
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition>
    processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable)
    Get all process definitions by pages
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition>
    processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, List<String> include)
    Get all process definitions by pages with include parameter
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition>
    processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload)
    Get all process definitions by pages using payload filters
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition>
    processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload, List<String> include)
    Get all process definitions by pages using payload filters and include parameter
    org.activiti.api.process.model.ProcessInstance
    processInstance(String processInstanceId)
    Get Process Instance by id
    org.activiti.api.process.model.ProcessInstanceMeta
    processInstanceMeta(String processInstanceId)
     
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessInstance>
    processInstances(org.activiti.api.runtime.shared.query.Pageable pageable)
    Get all process instances by pages - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query service
    org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessInstance>
    processInstances(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessInstancesPayload getProcessInstancesPayload)
    Get all process instances by pages filtering by - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query service
    void
    receive(org.activiti.api.process.model.payloads.ReceiveMessagePayload messagePayload)
     
    void
    removeVariables(org.activiti.api.process.model.payloads.RemoveProcessVariablesPayload removeProcessVariablesPayload)
     
    org.activiti.api.process.model.ProcessInstance
    resume(org.activiti.api.process.model.payloads.ResumeProcessPayload resumeProcessPayload)
    Resume a suspended process instance
    org.activiti.api.process.model.Deployment
    selectLatestDeployment()
     
    void
    setVariables(org.activiti.api.process.model.payloads.SetProcessVariablesPayload setProcessVariablesPayload)
     
    void
    signal(org.activiti.api.process.model.payloads.SignalPayload signalPayload)
     
    org.activiti.api.process.model.ProcessInstance
    start(org.activiti.api.process.model.payloads.StartMessagePayload messagePayload)
     
    org.activiti.api.process.model.ProcessInstance
    start(org.activiti.api.process.model.payloads.StartProcessPayload startProcessPayload)
    Start a new Process Instance based on the payload parameters
    org.activiti.api.process.model.ProcessInstance
    startCreatedProcess(String processInstanceId, org.activiti.api.process.model.payloads.StartProcessPayload startProcessPayload)
    Start an already created Process Instance based on the process instance id
    org.activiti.api.process.model.ProcessInstance
    suspend(org.activiti.api.process.model.payloads.SuspendProcessPayload suspendProcessPayload)
    Suspend a process instance
    org.activiti.api.process.model.ProcessInstance
    update(org.activiti.api.process.model.payloads.UpdateProcessPayload updateProcessPayload)
    Update a Process Instance
    List<org.activiti.api.model.shared.model.VariableInstance>
    variables(org.activiti.api.process.model.payloads.GetVariablesPayload getVariablesPayload)
     

  • Method Details

    • configuration

      ProcessRuntimeConfiguration configuration()
      Returns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listeners

    • processDefinition

      org.activiti.api.process.model.ProcessDefinition processDefinition(String processDefinitionId)
      Get process definition by key or id (where the ID is autogenerated at deployment time)

    • processDefinitions

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition> processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable)
      Get all process definitions by pages

    • processDefinitions

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition> processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, List<String> include)
      Get all process definitions by pages with include parameter

    • processDefinitions

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition> processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload)
      Get all process definitions by pages using payload filters

    • processDefinitions

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessDefinition> processDefinitions(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload, List<String> include)
      Get all process definitions by pages using payload filters and include parameter

    • start

      org.activiti.api.process.model.ProcessInstance start(org.activiti.api.process.model.payloads.StartProcessPayload startProcessPayload)
      Start a new Process Instance based on the payload parameters

    • startCreatedProcess

      org.activiti.api.process.model.ProcessInstance startCreatedProcess(String processInstanceId, org.activiti.api.process.model.payloads.StartProcessPayload startProcessPayload)
      Start an already created Process Instance based on the process instance id

    • create

      org.activiti.api.process.model.ProcessInstance create(org.activiti.api.process.model.payloads.CreateProcessInstancePayload startProcessPayload)
      Create a new Process Instance based on the payload parameters

    • processInstances

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessInstance> processInstances(org.activiti.api.runtime.shared.query.Pageable pageable)
      Get all process instances by pages - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query service

    • processInstances

      org.activiti.api.runtime.shared.query.Page<org.activiti.api.process.model.ProcessInstance> processInstances(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.process.model.payloads.GetProcessInstancesPayload getProcessInstancesPayload)
      Get all process instances by pages filtering by - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query service

    • processInstance

      org.activiti.api.process.model.ProcessInstance processInstance(String processInstanceId)
      Get Process Instance by id

    • suspend

      org.activiti.api.process.model.ProcessInstance suspend(org.activiti.api.process.model.payloads.SuspendProcessPayload suspendProcessPayload)
      Suspend a process instance

    • resume

      org.activiti.api.process.model.ProcessInstance resume(org.activiti.api.process.model.payloads.ResumeProcessPayload resumeProcessPayload)
      Resume a suspended process instance

    • delete

      org.activiti.api.process.model.ProcessInstance delete(org.activiti.api.process.model.payloads.DeleteProcessPayload deleteProcessPayload)
      Delete a Process Instance

    • update

      org.activiti.api.process.model.ProcessInstance update(org.activiti.api.process.model.payloads.UpdateProcessPayload updateProcessPayload)
      Update a Process Instance

    • signal

      void signal(org.activiti.api.process.model.payloads.SignalPayload signalPayload)

    • processDefinitionMeta

      org.activiti.api.process.model.ProcessDefinitionMeta processDefinitionMeta(String processDefinitionKey)

    • processInstanceMeta

      org.activiti.api.process.model.ProcessInstanceMeta processInstanceMeta(String processInstanceId)

    • variables

      List<org.activiti.api.model.shared.model.VariableInstance> variables(org.activiti.api.process.model.payloads.GetVariablesPayload getVariablesPayload)

    • removeVariables

      void removeVariables(org.activiti.api.process.model.payloads.RemoveProcessVariablesPayload removeProcessVariablesPayload)

    • setVariables

      void setVariables(org.activiti.api.process.model.payloads.SetProcessVariablesPayload setProcessVariablesPayload)

    • receive

      void receive(org.activiti.api.process.model.payloads.ReceiveMessagePayload messagePayload)

    • start

      org.activiti.api.process.model.ProcessInstance start(org.activiti.api.process.model.payloads.StartMessagePayload messagePayload)

    • selectLatestDeployment

      org.activiti.api.process.model.Deployment selectLatestDeployment()