Package org.activiti.api.process.runtime

Interface ProcessAdminRuntime

  • public interface ProcessAdminRuntime

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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​(java.lang.String processDefinitionId)
      Get process definition by key or id (where the ID is autogenerated at deployment time)
      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, org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload)
      Get all process definitions by pages using payload filters
      org.activiti.api.process.model.ProcessInstance processInstance​(java.lang.String processInstanceId)
      Get Process Instance by id
      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 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
      void setVariables​(org.activiti.api.process.model.payloads.SetProcessVariablesPayload setProcessVariablesPayload)  
      void signal​(org.activiti.api.process.model.payloads.SignalPayload signalPayload)
      Signal
      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 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

    • Method Detail

      • processDefinition

        org.activiti.api.process.model.ProcessDefinition processDefinition​(java.lang.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,
                                                                                                                org.activiti.api.process.model.payloads.GetProcessDefinitionsPayload getProcessDefinitionsPayload)
        Get all process definitions by pages using payload filters

      • 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

      • 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​(java.lang.String processInstanceId)
        Get Process Instance by id

      • delete

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

      • signal

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

      • 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

      • update

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

      • setVariables

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

      • removeVariables

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