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 begin, 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 begin, 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 andOperator, int begin, 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 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 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 andOperator, int begin, 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 begin, 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 begin, 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

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

getCurrentTasks

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

getCurrentTasksXml

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

getDefinition

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

getDefinitions

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

getDefinitionsXml

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

getDefinitionsCount

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

getDefinitionsCountXml

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

getDefinitionXml

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

getInstances

public 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 andOperator,
                                   int begin,
                                   int end)
                            throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesCount

public 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 andOperator)
                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesCountXml

public 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 andOperator)
                                      throws WorkflowComponentException
Throws:
WorkflowComponentException

getInstancesXml

public 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 andOperator,
                                        int begin,
                                        int end)
                                 throws WorkflowComponentException
Throws:
WorkflowComponentException

getTaskFormElements

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

getTaskFormElementsXml

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

getTaskTransitions

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

getTaskTransitionsXml

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

getUserTasks

public 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 begin,
                                   int end)
                            throws WorkflowComponentException
Throws:
WorkflowComponentException

getUserTasksCount

public 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

public 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

public 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 begin,
                                        int end)
                                 throws WorkflowComponentException
Throws:
WorkflowComponentException

signalInstance

public void signalInstance(long instanceId)
                    throws WorkflowComponentException
Throws:
WorkflowComponentException

signalToken

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

startWorkflow

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

updateTask

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

updateTaskXml

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