com.liferay.portal.kernel.jbi
Interface WorkflowComponent


public interface WorkflowComponent

View Source

Author:
Charles May

Method Summary
 java.lang.String deploy(java.lang.String xml)
           
 java.util.List getCurrentTasks(long instanceId, long tokenId)
           
 java.lang.String getCurrentTasksXml(long instanceId, long tokenId)
           
 java.lang.Object getDefinition(long definitionId)
           
 java.util.List getDefinitions(long definitionId, java.lang.String name, int start, int end)
           
 int getDefinitionsCount(long definitionId, java.lang.String name)
           
 java.lang.String getDefinitionsCountXml(long definitionId, java.lang.String name)
           
 java.lang.String getDefinitionsXml(long definitionId, java.lang.String name, int start, int end)
           
 java.lang.String getDefinitionXml(long definitionId)
           
 java.util.List getInstances(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int start, int end)
           
 int getInstancesCount(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
 java.lang.String getInstancesCountXml(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator)
           
 java.lang.String getInstancesXml(long definitionId, long instanceId, java.lang.String definitionName, java.lang.String definitionVersion, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean retrieveUserInstances, boolean andOperator, int start, int end)
           
 java.util.List getTaskFormElements(long taskId)
           
 java.lang.String getTaskFormElementsXml(long taskId)
           
 java.util.List getTaskTransitions(long taskId)
           
 java.lang.String getTaskTransitionsXml(long taskId)
           
 java.util.List getUserTasks(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int start, int end)
           
 int getUserTasksCount(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
 java.lang.String getUserTasksCountXml(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator)
           
 java.lang.String getUserTasksXml(long instanceId, java.lang.String taskName, java.lang.String definitionName, java.lang.String assignedTo, java.lang.String createDateGT, java.lang.String createDateLT, java.lang.String startDateGT, java.lang.String startDateLT, java.lang.String endDateGT, java.lang.String endDateLT, boolean hideEndedTasks, boolean andOperator, int start, int end)
           
 void signalInstance(long instanceId)
           
 void signalToken(long instanceId, long tokenId)
           
 java.lang.String startWorkflow(long definitionId)
           
 java.util.Map updateTask(long taskId, java.lang.String transition, java.util.Map parameterMap)
           
 java.lang.String updateTaskXml(long taskId, java.lang.String transition, java.util.Map parameterMap)
           
 

Method Detail

deploy

java.lang.String deploy(java.lang.String xml)
                        throws WorkflowComponentException
Throws:
WorkflowComponentException

getCurrentTasks

java.util.List getCurrentTasks(long instanceId,
                               long tokenId)
                               throws WorkflowComponentException
Throws:
WorkflowComponentException

getCurrentTasksXml

java.lang.String getCurrentTasksXml(long instanceId,
                                    long tokenId)
                                    throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinition

java.lang.Object getDefinition(long definitionId)
                               throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinitions

java.util.List getDefinitions(long definitionId,
                              java.lang.String name,
                              int start,
                              int end)
                              throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinitionsXml

java.lang.String getDefinitionsXml(long definitionId,
                                   java.lang.String name,
                                   int start,
                                   int end)
                                   throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinitionsCount

int getDefinitionsCount(long definitionId,
                        java.lang.String name)
                        throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinitionsCountXml

java.lang.String getDefinitionsCountXml(long definitionId,
                                        java.lang.String name)
                                        throws WorkflowComponentException
Throws:
WorkflowComponentException

getDefinitionXml

java.lang.String getDefinitionXml(long definitionId)
                                  throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstances

java.util.List getInstances(long definitionId,
                            long instanceId,
                            java.lang.String definitionName,
                            java.lang.String definitionVersion,
                            java.lang.String startDateGT,
                            java.lang.String startDateLT,
                            java.lang.String endDateGT,
                            java.lang.String endDateLT,
                            boolean hideEndedTasks,
                            boolean retrieveUserInstances,
                            boolean andOperator,
                            int start,
                            int end)
                            throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesCount

int getInstancesCount(long definitionId,
                      long instanceId,
                      java.lang.String definitionName,
                      java.lang.String definitionVersion,
                      java.lang.String startDateGT,
                      java.lang.String startDateLT,
                      java.lang.String endDateGT,
                      java.lang.String endDateLT,
                      boolean hideEndedTasks,
                      boolean retrieveUserInstances,
                      boolean andOperator)
                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesCountXml

java.lang.String getInstancesCountXml(long definitionId,
                                      long instanceId,
                                      java.lang.String definitionName,
                                      java.lang.String definitionVersion,
                                      java.lang.String startDateGT,
                                      java.lang.String startDateLT,
                                      java.lang.String endDateGT,
                                      java.lang.String endDateLT,
                                      boolean hideEndedTasks,
                                      boolean retrieveUserInstances,
                                      boolean andOperator)
                                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesXml

java.lang.String getInstancesXml(long definitionId,
                                 long instanceId,
                                 java.lang.String definitionName,
                                 java.lang.String definitionVersion,
                                 java.lang.String startDateGT,
                                 java.lang.String startDateLT,
                                 java.lang.String endDateGT,
                                 java.lang.String endDateLT,
                                 boolean hideEndedTasks,
                                 boolean retrieveUserInstances,
                                 boolean andOperator,
                                 int start,
                                 int end)
                                 throws WorkflowComponentException
Throws:
WorkflowComponentException

getTaskFormElements

java.util.List getTaskFormElements(long taskId)
                                   throws WorkflowComponentException
Throws:
WorkflowComponentException

getTaskFormElementsXml

java.lang.String getTaskFormElementsXml(long taskId)
                                        throws WorkflowComponentException
Throws:
WorkflowComponentException

getTaskTransitions

java.util.List getTaskTransitions(long taskId)
                                  throws WorkflowComponentException
Throws:
WorkflowComponentException

getTaskTransitionsXml

java.lang.String getTaskTransitionsXml(long taskId)
                                       throws WorkflowComponentException
Throws:
WorkflowComponentException

getUserTasks

java.util.List getUserTasks(long instanceId,
                            java.lang.String taskName,
                            java.lang.String definitionName,
                            java.lang.String assignedTo,
                            java.lang.String createDateGT,
                            java.lang.String createDateLT,
                            java.lang.String startDateGT,
                            java.lang.String startDateLT,
                            java.lang.String endDateGT,
                            java.lang.String endDateLT,
                            boolean hideEndedTasks,
                            boolean andOperator,
                            int start,
                            int end)
                            throws WorkflowComponentException
Throws:
WorkflowComponentException

getUserTasksCount

int getUserTasksCount(long instanceId,
                      java.lang.String taskName,
                      java.lang.String definitionName,
                      java.lang.String assignedTo,
                      java.lang.String createDateGT,
                      java.lang.String createDateLT,
                      java.lang.String startDateGT,
                      java.lang.String startDateLT,
                      java.lang.String endDateGT,
                      java.lang.String endDateLT,
                      boolean hideEndedTasks,
                      boolean andOperator)
                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getUserTasksCountXml

java.lang.String getUserTasksCountXml(long instanceId,
                                      java.lang.String taskName,
                                      java.lang.String definitionName,
                                      java.lang.String assignedTo,
                                      java.lang.String createDateGT,
                                      java.lang.String createDateLT,
                                      java.lang.String startDateGT,
                                      java.lang.String startDateLT,
                                      java.lang.String endDateGT,
                                      java.lang.String endDateLT,
                                      boolean hideEndedTasks,
                                      boolean andOperator)
                                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getUserTasksXml

java.lang.String getUserTasksXml(long instanceId,
                                 java.lang.String taskName,
                                 java.lang.String definitionName,
                                 java.lang.String assignedTo,
                                 java.lang.String createDateGT,
                                 java.lang.String createDateLT,
                                 java.lang.String startDateGT,
                                 java.lang.String startDateLT,
                                 java.lang.String endDateGT,
                                 java.lang.String endDateLT,
                                 boolean hideEndedTasks,
                                 boolean andOperator,
                                 int start,
                                 int end)
                                 throws WorkflowComponentException
Throws:
WorkflowComponentException

signalInstance

void signalInstance(long instanceId)
                    throws WorkflowComponentException
Throws:
WorkflowComponentException

signalToken

void signalToken(long instanceId,
                 long tokenId)
                 throws WorkflowComponentException
Throws:
WorkflowComponentException

startWorkflow

java.lang.String startWorkflow(long definitionId)
                               throws WorkflowComponentException
Throws:
WorkflowComponentException

updateTask

java.util.Map updateTask(long taskId,
                         java.lang.String transition,
                         java.util.Map parameterMap)
                         throws WorkflowComponentException
Throws:
WorkflowComponentException

updateTaskXml

java.lang.String updateTaskXml(long taskId,
                               java.lang.String transition,
                               java.util.Map parameterMap)
                               throws WorkflowComponentException
Throws:
WorkflowComponentException