com.liferay.portal.kernel.workflow

Interface WorkflowInstanceManager

@MessagingProxy(mode=SYNC)
public interface WorkflowInstanceManager

Author:

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

Method Summary

Modifier and Type	Method and Description
void	deleteWorkflowInstance(long companyId, long workflowInstanceId)
java.util.List<java.lang.String>	getNextTransitionNames(long companyId, long userId, long workflowInstanceId)
WorkflowInstance	getWorkflowInstance(long companyId, long workflowInstanceId)
int	getWorkflowInstanceCount(long companyId, java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed)
int	getWorkflowInstanceCount(long companyId, java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed)
int	getWorkflowInstanceCount(long companyId, java.lang.String workflowDefinitionName, java.lang.Integer workflowDefinitionVersion, java.lang.Boolean completed)
java.util.List<WorkflowInstance>	getWorkflowInstances(long companyId, java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator)
java.util.List<WorkflowInstance>	getWorkflowInstances(long companyId, java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator)
java.util.List<WorkflowInstance>	getWorkflowInstances(long companyId, java.lang.String workflowDefinitionName, java.lang.Integer workflowDefinitionVersion, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator)
java.util.List<WorkflowInstance>	search(long companyId, java.lang.Long userId, java.lang.String assetType, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator)
int	searchCount(long companyId, java.lang.Long userId, java.lang.String assetType, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed)
WorkflowInstance	signalWorkflowInstance(long companyId, long userId, long workflowInstanceId, java.lang.String transitionName, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
WorkflowInstance	startWorkflowInstance(long companyId, long groupId, long userId, java.lang.String workflowDefinitionName, java.lang.Integer workflowDefinitionVersion, java.lang.String transitionName, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
WorkflowInstance	updateWorkflowContext(long companyId, long workflowInstanceId, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)

Method Detail

deleteWorkflowInstance

void deleteWorkflowInstance(long companyId,
                            long workflowInstanceId)
                     throws WorkflowException

Throws:

WorkflowException

getNextTransitionNames

java.util.List<java.lang.String> getNextTransitionNames(long companyId,
                                                        long userId,
                                                        long workflowInstanceId)
                                                 throws WorkflowException

Throws:

WorkflowException

getWorkflowInstance

WorkflowInstance getWorkflowInstance(long companyId,
                                     long workflowInstanceId)
                              throws WorkflowException

Throws:

WorkflowException

getWorkflowInstanceCount

int getWorkflowInstanceCount(long companyId,
                             java.lang.Long userId,
                             java.lang.String assetClassName,
                             java.lang.Long assetClassPK,
                             java.lang.Boolean completed)
                      throws WorkflowException

Throws:

WorkflowException

getWorkflowInstanceCount

int getWorkflowInstanceCount(long companyId,
                             java.lang.Long userId,
                             java.lang.String[] assetClassNames,
                             java.lang.Boolean completed)
                      throws WorkflowException

Throws:

WorkflowException

getWorkflowInstanceCount

int getWorkflowInstanceCount(long companyId,
                             java.lang.String workflowDefinitionName,
                             java.lang.Integer workflowDefinitionVersion,
                             java.lang.Boolean completed)
                      throws WorkflowException

Throws:

WorkflowException

getWorkflowInstances

java.util.List<WorkflowInstance> getWorkflowInstances(long companyId,
                                                      java.lang.Long userId,
                                                      java.lang.String assetClassName,
                                                      java.lang.Long assetClassPK,
                                                      java.lang.Boolean completed,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<WorkflowInstance> orderByComparator)
                                               throws WorkflowException

Throws:

WorkflowException

getWorkflowInstances

java.util.List<WorkflowInstance> getWorkflowInstances(long companyId,
                                                      java.lang.Long userId,
                                                      java.lang.String[] assetClassNames,
                                                      java.lang.Boolean completed,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<WorkflowInstance> orderByComparator)
                                               throws WorkflowException

Throws:

WorkflowException

getWorkflowInstances

java.util.List<WorkflowInstance> getWorkflowInstances(long companyId,
                                                      java.lang.String workflowDefinitionName,
                                                      java.lang.Integer workflowDefinitionVersion,
                                                      java.lang.Boolean completed,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<WorkflowInstance> orderByComparator)
                                               throws WorkflowException

Throws:

WorkflowException

search

java.util.List<WorkflowInstance> search(long companyId,
                                        java.lang.Long userId,
                                        java.lang.String assetType,
                                        java.lang.String nodeName,
                                        java.lang.String kaleoDefinitionName,
                                        java.lang.Boolean completed,
                                        int start,
                                        int end,
                                        OrderByComparator<WorkflowInstance> orderByComparator)
                                 throws WorkflowException

Throws:

WorkflowException

searchCount

int searchCount(long companyId,
                java.lang.Long userId,
                java.lang.String assetType,
                java.lang.String nodeName,
                java.lang.String kaleoDefinitionName,
                java.lang.Boolean completed)
         throws WorkflowException

Throws:

WorkflowException

signalWorkflowInstance

WorkflowInstance signalWorkflowInstance(long companyId,
                                        long userId,
                                        long workflowInstanceId,
                                        java.lang.String transitionName,
                                        java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                                 throws WorkflowException

Throws:

WorkflowException

startWorkflowInstance

WorkflowInstance startWorkflowInstance(long companyId,
                                       long groupId,
                                       long userId,
                                       java.lang.String workflowDefinitionName,
                                       java.lang.Integer workflowDefinitionVersion,
                                       java.lang.String transitionName,
                                       java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                                throws WorkflowException

Throws:

WorkflowException

updateWorkflowContext

WorkflowInstance updateWorkflowContext(long companyId,
                                       long workflowInstanceId,
                                       java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                                throws WorkflowException

Throws:

WorkflowException