com.liferay.portal.workflow.kaleo.runtime

Interface WorkflowEngine

@ProviderType
public interface WorkflowEngine

Method Summary

Modifier and Type	Method and Description
void	deleteWorkflowDefinition(java.lang.String name, int version, ServiceContext serviceContext)
void	deleteWorkflowInstance(long workflowInstanceId, ServiceContext serviceContext)
default WorkflowDefinition	deployWorkflowDefinition(java.lang.String title, java.lang.String name, java.io.InputStream inputStream, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by #deployWorkflowDefinition(String, String, String, byte[], ServiceContext)
WorkflowDefinition	deployWorkflowDefinition(java.lang.String title, java.lang.String name, java.lang.String scope, java.io.InputStream inputStream, ServiceContext serviceContext)
ExecutionContext	executeTimerWorkflowInstance(long kaleoTimerInstanceTokenId, ServiceContext serviceContext, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
java.util.List<java.lang.String>	getNextTransitionNames(long workflowInstanceId, ServiceContext serviceContext)
WorkflowInstance	getWorkflowInstance(long workflowInstanceId, ServiceContext serviceContext)
int	getWorkflowInstanceCount(java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed, ServiceContext serviceContext)
int	getWorkflowInstanceCount(java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed, ServiceContext serviceContext)
int	getWorkflowInstanceCount(java.lang.String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, ServiceContext serviceContext)
java.util.List<WorkflowInstance>	getWorkflowInstances(java.lang.Long userId, java.lang.String[] assetClassNames, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext)
java.util.List<WorkflowInstance>	getWorkflowInstances(java.lang.Long userId, java.lang.String assetClassName, java.lang.Long assetClassPK, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext)
java.util.List<WorkflowInstance>	getWorkflowInstances(java.lang.String workflowDefinitionName, int workflowDefinitionVersion, boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext)
default WorkflowDefinition	saveWorkflowDefinition(java.lang.String title, java.lang.String name, byte[] bytes, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by saveWorkflowDefinition(String, String, String, byte[], ServiceContext)
WorkflowDefinition	saveWorkflowDefinition(java.lang.String title, java.lang.String name, java.lang.String scope, byte[] bytes, ServiceContext serviceContext)
default java.util.List<WorkflowInstance>	search(java.lang.Long userId, java.lang.String assetClassName, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext) Deprecated. As of Mueller (7.2.x), replaced by search(Long, String, String, String, String, String, Boolean, int, int, OrderByComparator, ServiceContext)
default java.util.List<WorkflowInstance>	search(java.lang.Long userId, java.lang.String assetClassName, java.lang.String assetTitle, java.lang.String assetDescription, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext)
default int	searchCount(java.lang.Long userId, java.lang.String assetClassName, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, ServiceContext serviceContext) Deprecated. As of Mueller (7.2.x), replaced by searchCount(Long, String, String, String, String, String, Boolean, ServiceContext)
default int	searchCount(java.lang.Long userId, java.lang.String assetClassName, java.lang.String assetTitle, java.lang.String assetDescription, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, ServiceContext serviceContext)
default WorkflowModelSearchResult<WorkflowInstance>	searchWorkflowInstances(java.lang.Long userId, java.lang.String assetClassName, java.lang.String assetTitle, java.lang.String assetDescription, java.lang.String nodeName, java.lang.String kaleoDefinitionName, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowInstance> orderByComparator, ServiceContext serviceContext)
WorkflowInstance	signalWorkflowInstance(long workflowInstanceId, java.lang.String transitionName, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)
WorkflowInstance	startWorkflowInstance(java.lang.String workflowDefinitionName, java.lang.Integer workflowDefinitionVersion, java.lang.String transitionName, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)
WorkflowInstance	updateContext(long workflowInstanceId, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)
void	validateWorkflowDefinition(java.io.InputStream inputStream)

Method Detail

deleteWorkflowDefinition

void deleteWorkflowDefinition(java.lang.String name,
                              int version,
                              ServiceContext serviceContext)
                       throws WorkflowException

Throws:

WorkflowException

deleteWorkflowInstance

void deleteWorkflowInstance(long workflowInstanceId,
                            ServiceContext serviceContext)
                     throws WorkflowException

Throws:

WorkflowException

deployWorkflowDefinition

@Deprecated
default WorkflowDefinition deployWorkflowDefinition(java.lang.String title,
                                                                java.lang.String name,
                                                                java.io.InputStream inputStream,
                                                                ServiceContext serviceContext)
                                                         throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by #deployWorkflowDefinition(String, String, String, byte[], ServiceContext)

Throws:

WorkflowException

deployWorkflowDefinition

WorkflowDefinition deployWorkflowDefinition(java.lang.String title,
                                            java.lang.String name,
                                            java.lang.String scope,
                                            java.io.InputStream inputStream,
                                            ServiceContext serviceContext)
                                     throws WorkflowException

Throws:

WorkflowException

executeTimerWorkflowInstance

ExecutionContext executeTimerWorkflowInstance(long kaleoTimerInstanceTokenId,
                                              ServiceContext serviceContext,
                                              java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                                       throws WorkflowException

Throws:

WorkflowException

getNextTransitionNames

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

Throws:

WorkflowException

getWorkflowInstance

WorkflowInstance getWorkflowInstance(long workflowInstanceId,
                                     ServiceContext serviceContext)
                              throws WorkflowException

Throws:

WorkflowException

getWorkflowInstanceCount

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

Throws:

WorkflowException

getWorkflowInstanceCount

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

Throws:

WorkflowException

getWorkflowInstanceCount

int getWorkflowInstanceCount(java.lang.String workflowDefinitionName,
                             int workflowDefinitionVersion,
                             boolean completed,
                             ServiceContext serviceContext)
                      throws WorkflowException

Throws:

WorkflowException

getWorkflowInstances

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

Throws:

WorkflowException

getWorkflowInstances

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

Throws:

WorkflowException

getWorkflowInstances

java.util.List<WorkflowInstance> getWorkflowInstances(java.lang.String workflowDefinitionName,
                                                      int workflowDefinitionVersion,
                                                      boolean completed,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<WorkflowInstance> orderByComparator,
                                                      ServiceContext serviceContext)
                                               throws WorkflowException

Throws:

WorkflowException

saveWorkflowDefinition

@Deprecated
default WorkflowDefinition saveWorkflowDefinition(java.lang.String title,
                                                              java.lang.String name,
                                                              byte[] bytes,
                                                              ServiceContext serviceContext)
                                                       throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by saveWorkflowDefinition(String, String, String, byte[], ServiceContext)

Throws:

WorkflowException

saveWorkflowDefinition

WorkflowDefinition saveWorkflowDefinition(java.lang.String title,
                                          java.lang.String name,
                                          java.lang.String scope,
                                          byte[] bytes,
                                          ServiceContext serviceContext)
                                   throws WorkflowException

Throws:

WorkflowException

search

@Deprecated
default java.util.List<WorkflowInstance> search(java.lang.Long userId,
                                                            java.lang.String assetClassName,
                                                            java.lang.String nodeName,
                                                            java.lang.String kaleoDefinitionName,
                                                            java.lang.Boolean completed,
                                                            int start,
                                                            int end,
                                                            OrderByComparator<WorkflowInstance> orderByComparator,
                                                            ServiceContext serviceContext)
                                                     throws WorkflowException

Deprecated. As of Mueller (7.2.x), replaced by search(Long, String, String, String, String, String, Boolean, int, int, OrderByComparator, ServiceContext)

Throws:

WorkflowException

search

default java.util.List<WorkflowInstance> search(java.lang.Long userId,
                                                java.lang.String assetClassName,
                                                java.lang.String assetTitle,
                                                java.lang.String assetDescription,
                                                java.lang.String nodeName,
                                                java.lang.String kaleoDefinitionName,
                                                java.lang.Boolean completed,
                                                int start,
                                                int end,
                                                OrderByComparator<WorkflowInstance> orderByComparator,
                                                ServiceContext serviceContext)
                                         throws WorkflowException

Throws:

WorkflowException

searchCount

@Deprecated
default int searchCount(java.lang.Long userId,
                                    java.lang.String assetClassName,
                                    java.lang.String nodeName,
                                    java.lang.String kaleoDefinitionName,
                                    java.lang.Boolean completed,
                                    ServiceContext serviceContext)
                             throws WorkflowException

Deprecated. As of Mueller (7.2.x), replaced by searchCount(Long, String, String, String, String, String, Boolean, ServiceContext)

Throws:

WorkflowException

searchCount

default int searchCount(java.lang.Long userId,
                        java.lang.String assetClassName,
                        java.lang.String assetTitle,
                        java.lang.String assetDescription,
                        java.lang.String nodeName,
                        java.lang.String kaleoDefinitionName,
                        java.lang.Boolean completed,
                        ServiceContext serviceContext)
                 throws WorkflowException

Throws:

WorkflowException

searchWorkflowInstances

default WorkflowModelSearchResult<WorkflowInstance> searchWorkflowInstances(java.lang.Long userId,
                                                                            java.lang.String assetClassName,
                                                                            java.lang.String assetTitle,
                                                                            java.lang.String assetDescription,
                                                                            java.lang.String nodeName,
                                                                            java.lang.String kaleoDefinitionName,
                                                                            java.lang.Boolean completed,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<WorkflowInstance> orderByComparator,
                                                                            ServiceContext serviceContext)
                                                                     throws WorkflowException

Throws:

WorkflowException

signalWorkflowInstance

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

Throws:

WorkflowException

startWorkflowInstance

WorkflowInstance startWorkflowInstance(java.lang.String workflowDefinitionName,
                                       java.lang.Integer workflowDefinitionVersion,
                                       java.lang.String transitionName,
                                       java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                                       ServiceContext serviceContext)
                                throws WorkflowException

Throws:

WorkflowException

updateContext

WorkflowInstance updateContext(long workflowInstanceId,
                               java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                               ServiceContext serviceContext)
                        throws WorkflowException

Throws:

WorkflowException

validateWorkflowDefinition

void validateWorkflowDefinition(java.io.InputStream inputStream)
                         throws WorkflowException

Throws:

WorkflowException