com.openkm.module

Interface WorkflowModule

All Known Implementing Classes:

DbWorkflowModule, JcrWorkflowModule, OKMWorkflow

public interface WorkflowModule

Method Summary

Methods

Modifier and Type	Method and Description
void	addProcessInstanceVariable(String token, long processInstanceId, String name, Object value)
void	addTaskInstanceComment(String token, long taskInstanceId, String message)
void	addTaskInstanceVariable(String token, long taskInstanceId, String name, Object value)
void	addTokenComment(String token, long tokenId, String message)
void	deleteProcessDefinition(String token, long processDefinitionId) Delete a previously registered process definition.
void	deleteProcessInstance(String token, long processInstanceId)
void	deleteProcessInstanceVariable(String token, long processInstanceId, String name)
void	deleteTaskInstanceVariable(String token, long taskInstanceId, String name)
void	endProcessInstance(String token, long processInstanceId)
void	endTaskInstance(String token, long taskInstanceId, String transitionName)
void	endToken(String token, long tokenId)
List<ProcessDefinition>	findAllProcessDefinitions(String token) Get list of registered process definitions
List<ProcessDefinition>	findAllProcessDefinitionVersions(String token, String name) Get list of registered process definitions versions
ProcessDefinition	findLastProcessDefinition(String token, String name) Get last version of a given process definition.
List<ProcessDefinition>	findLatestProcessDefinitions(String token) Get list of registered process definitions.
List<TaskInstance>	findPooledTaskInstances(String token)
List<ProcessInstance>	findProcessInstances(String token, long processDefinitionId)
List<TaskInstance>	findTaskInstances(String token, long processInstanceId)
List<TaskInstance>	findUserTaskInstances(String token)
ProcessDefinition	getProcessDefinition(String token, long processDefinitionId) Gets a process definition from the engine by the identifier.
Map<String,List<FormElement>>	getProcessDefinitionForms(String token, long processDefinitionId) Obtain a map with the forms defined in the process definition.
byte[]	getProcessDefinitionImage(String token, long processDefinitionId, String node) Get a visual representation of the process definition.
ProcessInstance	getProcessInstance(String token, long processInstanceId)
TaskInstance	getTaskInstance(String token, long taskInstanceId)
Token	getToken(String token, long tokenId)
void	registerProcessDefinition(String token, InputStream is) Register a new process definition in the workflow engine.
void	resumeProcessInstance(String token, long processInstanceId)
void	resumeTaskInstance(String token, long taskInstanceId)
void	resumeToken(String token, long tokenId)
ProcessInstance	runProcessDefinition(String token, long processDefinitionId, String uuid, List<FormElement> vars) Run a process definition to create a process instance: begins a worflow process.
ProcessInstance	sendProcessInstanceSignal(String token, long processInstanceId, String transitionName)
Token	sendTokenSignal(String token, long tokenId, String transitionName)
void	setTaskInstanceActorId(String token, long taskInstanceId, String actorId)
void	setTaskInstanceValues(String token, long taskInstanceId, String transitionName, List<FormElement> values)
void	setTokenNode(String token, long tokenId, String nodeName)
void	startTaskInstance(String token, long taskInstanceId)
void	suspendProcessInstance(String token, long processInstanceId)
void	suspendTaskInstance(String token, long taskInstanceId)
void	suspendToken(String token, long tokenId)

Method Detail

registerProcessDefinition

void registerProcessDefinition(String token,
                             InputStream is)
                               throws ParseException,
                                      RepositoryException,
                                      DatabaseException,
                                      WorkflowException,
                                      IOException

Register a new process definition in the workflow engine.

Parameters:

token - The session authorization token.

is - Input stream where process definition can be read.

Throws:

ParseException - If there is an error parsing the forms.xml file.

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

IOException

deleteProcessDefinition

void deleteProcessDefinition(String token,
                           long processDefinitionId)
                             throws RepositoryException,
                                    DatabaseException,
                                    WorkflowException

Delete a previously registered process definition.

Parameters:

token - The session authorization token.

processDefinitionId - Process definition identifier.

Throws:

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

getProcessDefinition

ProcessDefinition getProcessDefinition(String token,
                                     long processDefinitionId)
                                       throws RepositoryException,
                                              DatabaseException,
                                              WorkflowException

Gets a process definition from the engine by the identifier.

Parameters:

token - The session authorization token.

processDefinitionId - Process definition identifier.

Throws:

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

getProcessDefinitionImage

byte[] getProcessDefinitionImage(String token,
                               long processDefinitionId,
                               String node)
                                 throws RepositoryException,
                                        DatabaseException,
                                        WorkflowException

Get a visual representation of the process definition.

Parameters:

token - The session authorization token.

processDefinitionId - Process definition identifier.

node - Mark the designed node as active, if not null.

Throws:

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

getProcessDefinitionForms

Map<String,List<FormElement>> getProcessDefinitionForms(String token,
                                                      long processDefinitionId)
                                                        throws ParseException,
                                                               RepositoryException,
                                                               DatabaseException,
                                                               WorkflowException

Obtain a map with the forms defined in the process definition.

Parameters:

token - The session authorization token.

processDefinitionId - Process definition identifier.

Throws:

ParseException - If there is an error parsing the forms.xml file.

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

runProcessDefinition

ProcessInstance runProcessDefinition(String token,
                                   long processDefinitionId,
                                   String uuid,
                                   List<FormElement> vars)
                                     throws WorkflowException,
                                            AccessDeniedException,
                                            RepositoryException,
                                            DatabaseException

Run a process definition to create a process instance: begins a worflow process.

Parameters:

token - The session authorization token.

processDefinitionId - Process definition identifier.

uuid - Node identifier associated with the created process instance.

vars - A list of form elements with variable definitions.

Returns:

The created process instance.

Throws:

RepositoryException - If there is a general repository error.

DatabaseException - If there is a general database error.

WorkflowException - If there is any workflow engine error.

AccessDeniedException

sendProcessInstanceSignal

ProcessInstance sendProcessInstanceSignal(String token,
                                        long processInstanceId,
                                        String transitionName)
                                          throws RepositoryException,
                                                 DatabaseException,
                                                 WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

endProcessInstance

void endProcessInstance(String token,
                      long processInstanceId)
                        throws RepositoryException,
                               DatabaseException,
                               WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

deleteProcessInstance

void deleteProcessInstance(String token,
                         long processInstanceId)
                           throws RepositoryException,
                                  DatabaseException,
                                  WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

findProcessInstances

List<ProcessInstance> findProcessInstances(String token,
                                         long processDefinitionId)
                                           throws RepositoryException,
                                                  DatabaseException,
                                                  WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

findAllProcessDefinitions

List<ProcessDefinition> findAllProcessDefinitions(String token)
                                                  throws RepositoryException,
                                                         DatabaseException,
                                                         WorkflowException

Get list of registered process definitions

Throws:

RepositoryException

DatabaseException

WorkflowException

findLatestProcessDefinitions

List<ProcessDefinition> findLatestProcessDefinitions(String token)
                                                     throws RepositoryException,
                                                            DatabaseException,
                                                            WorkflowException

Get list of registered process definitions. Only last version for each process

Throws:

RepositoryException

DatabaseException

WorkflowException

findLastProcessDefinition

ProcessDefinition findLastProcessDefinition(String token,
                                          String name)
                                            throws RepositoryException,
                                                   DatabaseException,
                                                   WorkflowException

Get last version of a given process definition.

Throws:

RepositoryException

DatabaseException

WorkflowException

findAllProcessDefinitionVersions

List<ProcessDefinition> findAllProcessDefinitionVersions(String token,
                                                       String name)
                                                         throws RepositoryException,
                                                                DatabaseException,
                                                                WorkflowException

Get list of registered process definitions versions

Throws:

RepositoryException

DatabaseException

WorkflowException

getProcessInstance

ProcessInstance getProcessInstance(String token,
                                 long processInstanceId)
                                   throws RepositoryException,
                                          DatabaseException,
                                          WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

suspendProcessInstance

void suspendProcessInstance(String token,
                          long processInstanceId)
                            throws RepositoryException,
                                   DatabaseException,
                                   WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

resumeProcessInstance

void resumeProcessInstance(String token,
                         long processInstanceId)
                           throws RepositoryException,
                                  DatabaseException,
                                  WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

addProcessInstanceVariable

void addProcessInstanceVariable(String token,
                              long processInstanceId,
                              String name,
                              Object value)
                                throws RepositoryException,
                                       DatabaseException,
                                       WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

deleteProcessInstanceVariable

void deleteProcessInstanceVariable(String token,
                                 long processInstanceId,
                                 String name)
                                   throws RepositoryException,
                                          DatabaseException,
                                          WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

findUserTaskInstances

List<TaskInstance> findUserTaskInstances(String token)
                                         throws RepositoryException,
                                                DatabaseException,
                                                WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

findPooledTaskInstances

List<TaskInstance> findPooledTaskInstances(String token)
                                           throws RepositoryException,
                                                  DatabaseException,
                                                  WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

findTaskInstances

List<TaskInstance> findTaskInstances(String token,
                                   long processInstanceId)
                                     throws RepositoryException,
                                            DatabaseException,
                                            WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

setTaskInstanceValues

void setTaskInstanceValues(String token,
                         long taskInstanceId,
                         String transitionName,
                         List<FormElement> values)
                           throws RepositoryException,
                                  DatabaseException,
                                  WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

addTaskInstanceComment

void addTaskInstanceComment(String token,
                          long taskInstanceId,
                          String message)
                            throws RepositoryException,
                                   DatabaseException,
                                   WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

getTaskInstance

TaskInstance getTaskInstance(String token,
                           long taskInstanceId)
                             throws RepositoryException,
                                    DatabaseException,
                                    WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

setTaskInstanceActorId

void setTaskInstanceActorId(String token,
                          long taskInstanceId,
                          String actorId)
                            throws RepositoryException,
                                   DatabaseException,
                                   WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

addTaskInstanceVariable

void addTaskInstanceVariable(String token,
                           long taskInstanceId,
                           String name,
                           Object value)
                             throws RepositoryException,
                                    DatabaseException,
                                    WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

deleteTaskInstanceVariable

void deleteTaskInstanceVariable(String token,
                              long taskInstanceId,
                              String name)
                                throws RepositoryException,
                                       DatabaseException,
                                       WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

startTaskInstance

void startTaskInstance(String token,
                     long taskInstanceId)
                       throws RepositoryException,
                              DatabaseException,
                              WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

endTaskInstance

void endTaskInstance(String token,
                   long taskInstanceId,
                   String transitionName)
                     throws RepositoryException,
                            DatabaseException,
                            WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

suspendTaskInstance

void suspendTaskInstance(String token,
                       long taskInstanceId)
                         throws RepositoryException,
                                DatabaseException,
                                WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

resumeTaskInstance

void resumeTaskInstance(String token,
                      long taskInstanceId)
                        throws RepositoryException,
                               DatabaseException,
                               WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

getToken

Token getToken(String token,
             long tokenId)
               throws RepositoryException,
                      DatabaseException,
                      WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

addTokenComment

void addTokenComment(String token,
                   long tokenId,
                   String message)
                     throws RepositoryException,
                            DatabaseException,
                            WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

suspendToken

void suspendToken(String token,
                long tokenId)
                  throws RepositoryException,
                         DatabaseException,
                         WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

resumeToken

void resumeToken(String token,
               long tokenId)
                 throws RepositoryException,
                        DatabaseException,
                        WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

sendTokenSignal

Token sendTokenSignal(String token,
                    long tokenId,
                    String transitionName)
                      throws RepositoryException,
                             DatabaseException,
                             WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

setTokenNode

void setTokenNode(String token,
                long tokenId,
                String nodeName)
                  throws RepositoryException,
                         DatabaseException,
                         WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException

endToken

void endToken(String token,
            long tokenId)
              throws RepositoryException,
                     DatabaseException,
                     WorkflowException

Throws:

RepositoryException

DatabaseException

WorkflowException