Interface WorkflowDefinitionManager


public interface WorkflowDefinitionManager
  • Method Summary

    Modifier and Type
    Method
    Description
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    deployWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, byte[] bytes)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    deployWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, String scope, byte[] bytes)
     
    List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getActiveWorkflowDefinitions(int start, int end)
     
    List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getActiveWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getActiveWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default int
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    getLatestWorkflowDefinition(long companyId, String name)
     
    default List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getLatestWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getLatestWorkflowDefinitions(Boolean active, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default int
     
    default int
    getLatestWorkflowDefinitionsCount(Boolean active, long companyId)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    getWorkflowDefinition(long workflowDefinitionId)
     
    com.liferay.portal.kernel.workflow.WorkflowDefinition
    getWorkflowDefinition(long companyId, String name, int version)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    getWorkflowDefinition(String externalReferenceCode, long companyId)
     
    List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    getWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default int
    getWorkflowDefinitionsCount(long companyId, String name)
     
    default List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    liberalGetActiveWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
     
    default List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    liberalGetLatestWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    liberalGetWorkflowDefinition(long companyId, String name, int version)
     
    default List<com.liferay.portal.kernel.workflow.WorkflowDefinition>
    liberalGetWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator)
     
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    saveWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, byte[] bytes)
    Saves a workflow definition without activating it or validating its data.
    default com.liferay.portal.kernel.workflow.WorkflowDefinition
    saveWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, String scope, byte[] bytes)
    Saves a workflow definition without activating it or validating its data.
    void
    undeployWorkflowDefinition(long companyId, long userId, String name, int version)
     
    com.liferay.portal.kernel.workflow.WorkflowDefinition
    updateActive(long companyId, long userId, String name, int version, boolean active)
     
    void
     
  • Method Details

    • deployWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition deployWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, byte[] bytes) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • deployWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition deployWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, String scope, byte[] bytes) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getActiveWorkflowDefinitions

      List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getActiveWorkflowDefinitions(int start, int end) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getActiveWorkflowDefinitions

      List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getActiveWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getActiveWorkflowDefinitions

      List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getActiveWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getActiveWorkflowDefinitionsCount

      default int getActiveWorkflowDefinitionsCount(long companyId) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getLatestWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition getLatestWorkflowDefinition(long companyId, String name) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getLatestWorkflowDefinitions

      default List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getLatestWorkflowDefinitions(Boolean active, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getLatestWorkflowDefinitions

      default List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getLatestWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getLatestWorkflowDefinitionsCount

      default int getLatestWorkflowDefinitionsCount(Boolean active, long companyId) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getLatestWorkflowDefinitionsCount

      default int getLatestWorkflowDefinitionsCount(long companyId) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition getWorkflowDefinition(long workflowDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWorkflowDefinition

      com.liferay.portal.kernel.workflow.WorkflowDefinition getWorkflowDefinition(long companyId, String name, int version) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition getWorkflowDefinition(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWorkflowDefinitions

      List<com.liferay.portal.kernel.workflow.WorkflowDefinition> getWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • getWorkflowDefinitionsCount

      default int getWorkflowDefinitionsCount(long companyId, String name) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • liberalGetActiveWorkflowDefinitions

      default List<com.liferay.portal.kernel.workflow.WorkflowDefinition> liberalGetActiveWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • liberalGetLatestWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition liberalGetLatestWorkflowDefinition(long companyId, String name) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • liberalGetLatestWorkflowDefinitions

      default List<com.liferay.portal.kernel.workflow.WorkflowDefinition> liberalGetLatestWorkflowDefinitions(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • liberalGetWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition liberalGetWorkflowDefinition(long companyId, String name, int version) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • liberalGetWorkflowDefinitions

      default List<com.liferay.portal.kernel.workflow.WorkflowDefinition> liberalGetWorkflowDefinitions(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.workflow.WorkflowDefinition> orderByComparator) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • saveWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition saveWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, byte[] bytes) throws com.liferay.portal.kernel.workflow.WorkflowException
      Saves a workflow definition without activating it or validating its data. To save the definition, validate its data, and activate it, use #deployWorkflowDefinition(long, long, String, String, byte[]) instead.
      Parameters:
      companyId - the company ID of the workflow definition
      userId - the ID of the user saving the workflow definition
      title - the workflow definition's title
      name - the workflow definition's name
      bytes - the data saved as the workflow definition's content
      Returns:
      the workflow definition
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException - if there was an issue saving the workflow definition
    • saveWorkflowDefinition

      default com.liferay.portal.kernel.workflow.WorkflowDefinition saveWorkflowDefinition(String externalReferenceCode, long companyId, long userId, String title, String name, String scope, byte[] bytes) throws com.liferay.portal.kernel.workflow.WorkflowException
      Saves a workflow definition without activating it or validating its data. To save the definition, validate its data, and activate it, use #deployWorkflowDefinition(long, long, String, String, byte[]) instead.
      Parameters:
      companyId - the company ID of the workflow definition
      userId - the ID of the user saving the workflow definition
      title - the workflow definition's title
      name - the workflow definition's name
      scope - the workflow definition's scope
      bytes - the data saved as the workflow definition's content
      Returns:
      the workflow definition
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException - if there was an issue saving the workflow definition
    • undeployWorkflowDefinition

      void undeployWorkflowDefinition(long companyId, long userId, String name, int version) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • updateActive

      com.liferay.portal.kernel.workflow.WorkflowDefinition updateActive(long companyId, long userId, String name, int version, boolean active) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException
    • validateWorkflowDefinition

      void validateWorkflowDefinition(byte[] bytes) throws com.liferay.portal.kernel.workflow.WorkflowException
      Throws:
      com.liferay.portal.kernel.workflow.WorkflowException