JcrWorkflowModule (OpenKM Web Application 6.3.0 API)

java.lang.Object
- com.openkm.module.jcr.JcrWorkflowModule

All Implemented Interfaces:: WorkflowModule

public class JcrWorkflowModule
extends Object
implements WorkflowModule

Constructor Summary

Constructors
Constructor and Description

JcrWorkflowModule()

Constructors
Constructor and Description
`JcrWorkflowModule()`

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> variables)` 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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- JcrWorkflowModule
```
public JcrWorkflowModule()
```

Method Detail

registerProcessDefinition

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

Description copied from interface: WorkflowModule

Specified by:: registerProcessDefinition in interface WorkflowModule
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.; WorkflowException - If there is any workflow engine error.; DatabaseException - If there is a general database error.; IOException

deleteProcessDefinition
```
public void deleteProcessDefinition(String token,
                           long processDefinitionId)
                             throws RepositoryException,
                                    DatabaseException,
                                    WorkflowException
```
Description copied from interface: WorkflowModule

Delete a previously registered process definition.

Specified by:

deleteProcessDefinition in interface WorkflowModule

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
```
public ProcessDefinition getProcessDefinition(String token,
                                     long processDefinitionId)
                                       throws RepositoryException,
                                              DatabaseException,
                                              WorkflowException
```
Description copied from interface: WorkflowModule

Gets a process definition from the engine by the identifier.

Specified by:

getProcessDefinition in interface WorkflowModule

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
```
public byte[] getProcessDefinitionImage(String token,
                               long processDefinitionId,
                               String node)
                                 throws RepositoryException,
                                        DatabaseException,
                                        WorkflowException
```
Description copied from interface: WorkflowModule

Get a visual representation of the process definition.

Specified by:

getProcessDefinitionImage in interface WorkflowModule

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

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

Description copied from interface: WorkflowModule

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

Specified by:: getProcessDefinitionForms in interface WorkflowModule
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
```
public ProcessInstance runProcessDefinition(String token,
                                   long processDefinitionId,
                                   String uuid,
                                   List<FormElement> variables)
                                     throws RepositoryException,
                                            DatabaseException,
                                            WorkflowException
```
Description copied from interface: WorkflowModule

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

Specified by:

runProcessDefinition in interface WorkflowModule

Parameters:
token - The session authorization token.
processDefinitionId - Process definition identifier.
uuid - Node identifier associated with the created process instance.
variables - 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.

sendProcessInstanceSignal

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

Specified by:: sendProcessInstanceSignal in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

endProcessInstance

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

Specified by:: endProcessInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

deleteProcessInstance

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

Specified by:: deleteProcessInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findProcessInstances

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

Specified by:: findProcessInstances in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findAllProcessDefinitions

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

Description copied from interface: WorkflowModule

Get list of registered process definitions

Specified by:: findAllProcessDefinitions in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findLatestProcessDefinitions

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

Description copied from interface: WorkflowModule

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

Specified by:: findLatestProcessDefinitions in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findLastProcessDefinition

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

Description copied from interface: WorkflowModule

Get last version of a given process definition.

Specified by:: findLastProcessDefinition in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findAllProcessDefinitionVersions

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

Description copied from interface: WorkflowModule

Get list of registered process definitions versions

Specified by:: findAllProcessDefinitionVersions in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

getProcessInstance

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

Specified by:: getProcessInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

suspendProcessInstance

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

Specified by:: suspendProcessInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

resumeProcessInstance

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

Specified by:: resumeProcessInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

addProcessInstanceVariable

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

Specified by:: addProcessInstanceVariable in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

deleteProcessInstanceVariable

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

Specified by:: deleteProcessInstanceVariable in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findUserTaskInstances

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

Specified by:: findUserTaskInstances in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findPooledTaskInstances

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

Specified by:: findPooledTaskInstances in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

findTaskInstances

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

Specified by:: findTaskInstances in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

setTaskInstanceValues

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

Specified by:: setTaskInstanceValues in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

addTaskInstanceComment

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

Specified by:: addTaskInstanceComment in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

getTaskInstance

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

Specified by:: getTaskInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

setTaskInstanceActorId

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

Specified by:: setTaskInstanceActorId in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

addTaskInstanceVariable

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

Specified by:: addTaskInstanceVariable in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

deleteTaskInstanceVariable

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

Specified by:: deleteTaskInstanceVariable in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

startTaskInstance

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

Specified by:: startTaskInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

endTaskInstance

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

Specified by:: endTaskInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

suspendTaskInstance

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

Specified by:: suspendTaskInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

resumeTaskInstance

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

Specified by:: resumeTaskInstance in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

getToken

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

Specified by:: getToken in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

addTokenComment

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

Specified by:: addTokenComment in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

suspendToken

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

Specified by:: suspendToken in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

resumeToken

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

Specified by:: resumeToken in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

sendTokenSignal

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

Specified by:: sendTokenSignal in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

setTokenNode

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

Specified by:: setTokenNode in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

endToken

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

Specified by:: endToken in interface WorkflowModule
Throws:: RepositoryException; DatabaseException; WorkflowException

Class JcrWorkflowModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JcrWorkflowModule

Method Detail

registerProcessDefinition

deleteProcessDefinition

getProcessDefinition

getProcessDefinitionImage

getProcessDefinitionForms

runProcessDefinition

sendProcessInstanceSignal

endProcessInstance

deleteProcessInstance

findProcessInstances

findAllProcessDefinitions

findLatestProcessDefinitions

findLastProcessDefinition

findAllProcessDefinitionVersions

getProcessInstance

suspendProcessInstance

resumeProcessInstance

addProcessInstanceVariable

deleteProcessInstanceVariable

findUserTaskInstances

findPooledTaskInstances

findTaskInstances

setTaskInstanceValues

addTaskInstanceComment

getTaskInstance

setTaskInstanceActorId

addTaskInstanceVariable

deleteTaskInstanceVariable

startTaskInstance

endTaskInstance

suspendTaskInstance

resumeTaskInstance

getToken

addTokenComment

suspendToken

resumeToken

sendTokenSignal

setTokenNode

endToken