Interface WorkflowEngine


@ProviderType public interface WorkflowEngine
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    deleteWorkflowDefinition(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    void
    deleteWorkflowInstance(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowDefinition
    deployWorkflowDefinition(String externalReferenceCode, String title, String name, String scope, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    executeTimerWorkflowInstance(long kaleoTimerInstanceTokenId, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String,Serializable> workflowContext)
     
    getNextTransitionNames(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    List<com.liferay.portal.kernel.workflow.WorkflowTransition>
    getNextWorkflowTransitions(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    getWorkflowInstance(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    int
    getWorkflowInstanceCount(Long userId, String[] assetClassNames, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    int
    getWorkflowInstanceCount(Long userId, String assetClassName, Long assetClassPK, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    int
    getWorkflowInstanceCount(String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    List<com.liferay.portal.kernel.workflow.WorkflowInstance>
    getWorkflowInstances(Long userId, String[] assetClassNames, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    List<com.liferay.portal.kernel.workflow.WorkflowInstance>
    getWorkflowInstances(Long userId, String assetClassName, Long assetClassPK, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    List<com.liferay.portal.kernel.workflow.WorkflowInstance>
    getWorkflowInstances(String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowDefinition
    saveWorkflowDefinition(String externalReferenceCode, String title, String name, String scope, byte[] bytes, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    default List<com.liferay.portal.kernel.workflow.WorkflowInstance>
    search(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    default int
    searchCount(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    default com.liferay.portal.kernel.workflow.search.WorkflowModelSearchResult<com.liferay.portal.kernel.workflow.WorkflowInstance>
    searchWorkflowInstances(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, boolean searchByActiveWorkflowHandlers, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    signalWorkflowInstance(long workflowInstanceId, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    signalWorkflowInstance(long workflowInstanceId, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext, boolean waitForCompletion)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    startWorkflowInstance(String workflowDefinitionName, Integer workflowDefinitionVersion, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    startWorkflowInstance(String workflowDefinitionName, Integer workflowDefinitionVersion, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext, boolean waitForCompletion)
     
    com.liferay.portal.kernel.workflow.WorkflowInstance
    updateContext(long workflowInstanceId, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    default com.liferay.portal.kernel.workflow.WorkflowInstance
    updateWorkflowInstanceActive(long userId, long companyId, long workflowInstanceId, boolean active)
     
    void
     
  • Method Details

    • deleteWorkflowDefinition

      void deleteWorkflowDefinition(String name, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • deleteWorkflowInstance

      void deleteWorkflowInstance(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • deployWorkflowDefinition

      com.liferay.portal.kernel.workflow.WorkflowDefinition deployWorkflowDefinition(String externalReferenceCode, String title, String name, String scope, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • executeTimerWorkflowInstance

      ExecutionContext executeTimerWorkflowInstance(long kaleoTimerInstanceTokenId, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String,Serializable> workflowContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getNextTransitionNames

      List<String> getNextTransitionNames(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getNextWorkflowTransitions

      List<com.liferay.portal.kernel.workflow.WorkflowTransition> getNextWorkflowTransitions(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstance

      com.liferay.portal.kernel.workflow.WorkflowInstance getWorkflowInstance(long workflowInstanceId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstanceCount

      int getWorkflowInstanceCount(Long userId, String assetClassName, Long assetClassPK, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstanceCount

      int getWorkflowInstanceCount(Long userId, String[] assetClassNames, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstanceCount

      int getWorkflowInstanceCount(String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstances

      List<com.liferay.portal.kernel.workflow.WorkflowInstance> getWorkflowInstances(Long userId, String assetClassName, Long assetClassPK, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstances

      List<com.liferay.portal.kernel.workflow.WorkflowInstance> getWorkflowInstances(Long userId, String[] assetClassNames, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowInstances

      List<com.liferay.portal.kernel.workflow.WorkflowInstance> getWorkflowInstances(String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • saveWorkflowDefinition

      com.liferay.portal.kernel.workflow.WorkflowDefinition saveWorkflowDefinition(String externalReferenceCode, String title, String name, String scope, byte[] bytes, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • search

      default List<com.liferay.portal.kernel.workflow.WorkflowInstance> search(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • searchCount

      default int searchCount(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • searchWorkflowInstances

      default com.liferay.portal.kernel.workflow.search.WorkflowModelSearchResult<com.liferay.portal.kernel.workflow.WorkflowInstance> searchWorkflowInstances(Long userId, Boolean active, String assetClassName, String assetTitle, String assetDescription, String nodeName, String kaleoDefinitionName, Boolean completed, boolean searchByActiveWorkflowHandlers, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowInstance> orderByComparator, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • signalWorkflowInstance

      com.liferay.portal.kernel.workflow.WorkflowInstance signalWorkflowInstance(long workflowInstanceId, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • signalWorkflowInstance

      com.liferay.portal.kernel.workflow.WorkflowInstance signalWorkflowInstance(long workflowInstanceId, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext, boolean waitForCompletion) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • startWorkflowInstance

      com.liferay.portal.kernel.workflow.WorkflowInstance startWorkflowInstance(String workflowDefinitionName, Integer workflowDefinitionVersion, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • startWorkflowInstance

      com.liferay.portal.kernel.workflow.WorkflowInstance startWorkflowInstance(String workflowDefinitionName, Integer workflowDefinitionVersion, String transitionName, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext, boolean waitForCompletion) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • updateContext

      com.liferay.portal.kernel.workflow.WorkflowInstance updateContext(long workflowInstanceId, Map<String,Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • updateWorkflowInstanceActive

      default com.liferay.portal.kernel.workflow.WorkflowInstance updateWorkflowInstanceActive(long userId, long companyId, long workflowInstanceId, boolean active) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • validateWorkflowDefinition

      void validateWorkflowDefinition(InputStream inputStream) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException