com.liferay.portal.kernel.workflow

Interface WorkflowDefinitionManager

@MessagingProxy(mode=SYNC)
public interface WorkflowDefinitionManager

Author:

Micha Kiener, Shuyang Zhou, Brian Wing Shun Chan, Marcellus Tavares, Eduardo Lundgren

Method Summary

Modifier and Type	Method and Description
WorkflowDefinition	deployWorkflowDefinition(long companyId, long userId, java.lang.String title, byte[] bytes) Deprecated. As of 7.0.0, replaced by deployWorkflowDefinition(long, long, String, String, byte[])
default WorkflowDefinition	deployWorkflowDefinition(long companyId, long userId, java.lang.String title, java.lang.String name, byte[] bytes)
int	getActiveWorkflowDefinitionCount(long companyId)
int	getActiveWorkflowDefinitionCount(long companyId, java.lang.String name)
java.util.List<WorkflowDefinition>	getActiveWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
java.util.List<WorkflowDefinition>	getActiveWorkflowDefinitions(long companyId, java.lang.String name, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
WorkflowDefinition	getLatestKaleoDefinition(long companyId, java.lang.String name) Deprecated. As of 7.0.0, replaced by getLatestWorkflowDefinition(long, String)
default WorkflowDefinition	getLatestWorkflowDefinition(long companyId, java.lang.String name)
default java.util.List<WorkflowDefinition>	getLatestWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
WorkflowDefinition	getWorkflowDefinition(long companyId, java.lang.String name, int version)
int	getWorkflowDefinitionCount(long companyId)
int	getWorkflowDefinitionCount(long companyId, java.lang.String name)
java.util.List<WorkflowDefinition>	getWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
java.util.List<WorkflowDefinition>	getWorkflowDefinitions(long companyId, java.lang.String name, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
default WorkflowDefinition	saveWorkflowDefinition(long companyId, long userId, java.lang.String title, java.lang.String name, byte[] bytes) Saves a workflow definition without activating it or validating its data.
void	undeployWorkflowDefinition(long companyId, long userId, java.lang.String name, int version)
WorkflowDefinition	updateActive(long companyId, long userId, java.lang.String name, int version, boolean active)
WorkflowDefinition	updateTitle(long companyId, long userId, java.lang.String name, int version, java.lang.String title)
void	validateWorkflowDefinition(byte[] bytes)

Method Detail

deployWorkflowDefinition

@Deprecated
WorkflowDefinition deployWorkflowDefinition(long companyId,
                                                        long userId,
                                                        java.lang.String title,
                                                        byte[] bytes)
                                                 throws WorkflowException

Deprecated. As of 7.0.0, replaced by deployWorkflowDefinition(long, long, String, String, byte[])

Throws:

WorkflowException

deployWorkflowDefinition

default WorkflowDefinition deployWorkflowDefinition(long companyId,
                                                    long userId,
                                                    java.lang.String title,
                                                    java.lang.String name,
                                                    byte[] bytes)
                                             throws WorkflowException

Throws:

WorkflowException

getActiveWorkflowDefinitionCount

int getActiveWorkflowDefinitionCount(long companyId)
                              throws WorkflowException

Throws:

WorkflowException

getActiveWorkflowDefinitionCount

int getActiveWorkflowDefinitionCount(long companyId,
                                     java.lang.String name)
                              throws WorkflowException

Throws:

WorkflowException

getActiveWorkflowDefinitions

java.util.List<WorkflowDefinition> getActiveWorkflowDefinitions(long companyId,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<WorkflowDefinition> orderByComparator)
                                                         throws WorkflowException

Throws:

WorkflowException

getActiveWorkflowDefinitions

java.util.List<WorkflowDefinition> getActiveWorkflowDefinitions(long companyId,
                                                                java.lang.String name,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<WorkflowDefinition> orderByComparator)
                                                         throws WorkflowException

Throws:

WorkflowException

getLatestKaleoDefinition

@Deprecated
WorkflowDefinition getLatestKaleoDefinition(long companyId,
                                                        java.lang.String name)
                                                 throws WorkflowException

Deprecated. As of 7.0.0, replaced by getLatestWorkflowDefinition(long, String)

Throws:

WorkflowException

getLatestWorkflowDefinition

default WorkflowDefinition getLatestWorkflowDefinition(long companyId,
                                                       java.lang.String name)
                                                throws WorkflowException

Throws:

WorkflowException

getLatestWorkflowDefinitions

default java.util.List<WorkflowDefinition> getLatestWorkflowDefinitions(long companyId,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator<WorkflowDefinition> orderByComparator)
                                                                 throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinition

WorkflowDefinition getWorkflowDefinition(long companyId,
                                         java.lang.String name,
                                         int version)
                                  throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinitionCount

int getWorkflowDefinitionCount(long companyId)
                        throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinitionCount

int getWorkflowDefinitionCount(long companyId,
                               java.lang.String name)
                        throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinitions

java.util.List<WorkflowDefinition> getWorkflowDefinitions(long companyId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator<WorkflowDefinition> orderByComparator)
                                                   throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinitions

java.util.List<WorkflowDefinition> getWorkflowDefinitions(long companyId,
                                                          java.lang.String name,
                                                          int start,
                                                          int end,
                                                          OrderByComparator<WorkflowDefinition> orderByComparator)
                                                   throws WorkflowException

Throws:

WorkflowException

saveWorkflowDefinition

default WorkflowDefinition saveWorkflowDefinition(long companyId,
                                                  long userId,
                                                  java.lang.String title,
                                                  java.lang.String name,
                                                  byte[] bytes)
                                           throws 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:

WorkflowException - if there was an issue saving the workflow definition

undeployWorkflowDefinition

void undeployWorkflowDefinition(long companyId,
                                long userId,
                                java.lang.String name,
                                int version)
                         throws WorkflowException

Throws:

WorkflowException

updateActive

WorkflowDefinition updateActive(long companyId,
                                long userId,
                                java.lang.String name,
                                int version,
                                boolean active)
                         throws WorkflowException

Throws:

WorkflowException

updateTitle

WorkflowDefinition updateTitle(long companyId,
                               long userId,
                               java.lang.String name,
                               int version,
                               java.lang.String title)
                        throws WorkflowException

Throws:

WorkflowException

validateWorkflowDefinition

void validateWorkflowDefinition(byte[] bytes)
                         throws WorkflowException

Throws:

WorkflowException