public interface WorkflowModule
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) |
void registerProcessDefinition(String token, InputStream is) throws ParseException, AccessDeniedException, RepositoryException, DatabaseException, WorkflowException, IOException
token
- The session authorization token.is
- Input stream where process definition can be read.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.AccessDeniedException
IOException
void deleteProcessDefinition(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
token
- The session authorization token.processDefinitionId
- Process definition identifier.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
ProcessDefinition getProcessDefinition(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
token
- The session authorization token.processDefinitionId
- Process definition identifier.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
byte[] getProcessDefinitionImage(String token, long processDefinitionId, String node) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
token
- The session authorization token.processDefinitionId
- Process definition identifier.node
- Mark the designed node as active, if not null.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
Map<String,List<FormElement>> getProcessDefinitionForms(String token, long processDefinitionId) throws ParseException, AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
token
- The session authorization token.processDefinitionId
- Process definition identifier.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.AccessDeniedException
ProcessInstance runProcessDefinition(String token, long processDefinitionId, String uuid, List<FormElement> vars) throws WorkflowException, AccessDeniedException, RepositoryException, DatabaseException
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.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
ProcessInstance sendProcessInstanceSignal(String token, long processInstanceId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void endProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void deleteProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<ProcessInstance> findProcessInstances(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<ProcessDefinition> findAllProcessDefinitions(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<ProcessDefinition> findLatestProcessDefinitions(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
ProcessDefinition findLastProcessDefinition(String token, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<ProcessDefinition> findAllProcessDefinitionVersions(String token, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
ProcessInstance getProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void suspendProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void resumeProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void addProcessInstanceVariable(String token, long processInstanceId, String name, Object value) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void deleteProcessInstanceVariable(String token, long processInstanceId, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<TaskInstance> findUserTaskInstances(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
List<TaskInstance> findPooledTaskInstances(String token) throws RepositoryException, AccessDeniedException, DatabaseException, WorkflowException
List<TaskInstance> findTaskInstances(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void setTaskInstanceValues(String token, long taskInstanceId, String transitionName, List<FormElement> values) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void addTaskInstanceComment(String token, long taskInstanceId, String message) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
TaskInstance getTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void setTaskInstanceActorId(String token, long taskInstanceId, String actorId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void addTaskInstanceVariable(String token, long taskInstanceId, String name, Object value) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void deleteTaskInstanceVariable(String token, long taskInstanceId, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void startTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void endTaskInstance(String token, long taskInstanceId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void suspendTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void resumeTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
Token getToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void addTokenComment(String token, long tokenId, String message) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void suspendToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void resumeToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
Token sendTokenSignal(String token, long tokenId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void setTokenNode(String token, long tokenId, String nodeName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
void endToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
Copyright © 2018 Open Knowledge Management System S.L.. All rights reserved.