com.liferay.portal.kernel.workflow

Class WorkflowDefinitionManagerUtil

java.lang.Object

com.liferay.portal.kernel.workflow.WorkflowDefinitionManagerUtil

public class WorkflowDefinitionManagerUtil
extends java.lang.Object

Author:

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

Constructor Summary

Constructors

Constructor and Description
WorkflowDefinitionManagerUtil()

Method Summary

Modifier and Type	Method and Description
static 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[])
static WorkflowDefinition	deployWorkflowDefinition(long companyId, long userId, java.lang.String title, java.lang.String name, byte[] bytes)
static int	getActiveWorkflowDefinitionCount(long companyId)
static int	getActiveWorkflowDefinitionCount(long companyId, java.lang.String name)
static java.util.List<WorkflowDefinition>	getActiveWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
static java.util.List<WorkflowDefinition>	getActiveWorkflowDefinitions(long companyId, java.lang.String name, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
static WorkflowDefinition	getLatestKaleoDefinition(long companyId, java.lang.String name) Deprecated. As of 7.0.0, replaced by getLatestWorkflowDefinition(long, String)
static WorkflowDefinition	getLatestWorkflowDefinition(long companyId, java.lang.String name)
static java.util.List<WorkflowDefinition>	getLatestWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
static WorkflowDefinition	getWorkflowDefinition(long companyId, java.lang.String name, int version)
static int	getWorkflowDefinitionCount(long companyId)
static int	getWorkflowDefinitionCount(long companyId, java.lang.String name)
static WorkflowDefinitionManager	getWorkflowDefinitionManager()
static java.util.List<WorkflowDefinition>	getWorkflowDefinitions(long companyId, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
static java.util.List<WorkflowDefinition>	getWorkflowDefinitions(long companyId, java.lang.String name, int start, int end, OrderByComparator<WorkflowDefinition> orderByComparator)
static 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	setWorkflowDefinitionManager(WorkflowDefinitionManager workflowDefinitionManager)
static void	undeployWorkflowDefinition(long companyId, long userId, java.lang.String name, int version)
static WorkflowDefinition	updateActive(long companyId, long userId, java.lang.String name, int version, boolean active)
static WorkflowDefinition	updateTitle(long companyId, long userId, java.lang.String name, int version, java.lang.String title)
static void	validateWorkflowDefinition(byte[] bytes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowDefinitionManagerUtil

public WorkflowDefinitionManagerUtil()

Method Detail

deployWorkflowDefinition

@Deprecated
public static 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

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

Throws:

WorkflowException

getActiveWorkflowDefinitionCount

public static int getActiveWorkflowDefinitionCount(long companyId)
                                            throws WorkflowException

Throws:

WorkflowException

getActiveWorkflowDefinitionCount

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

Throws:

WorkflowException

getActiveWorkflowDefinitions

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

Throws:

WorkflowException

getActiveWorkflowDefinitions

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

Throws:

WorkflowException

getLatestKaleoDefinition

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

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

Throws:

WorkflowException

getLatestWorkflowDefinition

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

Throws:

WorkflowException

getLatestWorkflowDefinitions

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

Throws:

WorkflowException

getWorkflowDefinition

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

Throws:

WorkflowException

getWorkflowDefinitionCount

public static int getWorkflowDefinitionCount(long companyId)
                                      throws WorkflowException

Throws:

WorkflowException

getWorkflowDefinitionCount

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

Throws:

WorkflowException

getWorkflowDefinitionManager

public static WorkflowDefinitionManager getWorkflowDefinitionManager()

getWorkflowDefinitions

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

Throws:

WorkflowException

getWorkflowDefinitions

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

Throws:

WorkflowException

saveWorkflowDefinition

public static 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

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

Throws:

WorkflowException

updateActive

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

Throws:

WorkflowException

updateTitle

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

Throws:

WorkflowException

validateWorkflowDefinition

public static void validateWorkflowDefinition(byte[] bytes)
                                       throws WorkflowException

Throws:

WorkflowException

setWorkflowDefinitionManager

public void setWorkflowDefinitionManager(WorkflowDefinitionManager workflowDefinitionManager)