public class OKMWorkflow extends Object implements 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) |
static OKMWorkflow |
getInstance() |
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) |
public static OKMWorkflow getInstance()
public void registerProcessDefinition(String token, InputStream is) throws ParseException, AccessDeniedException, RepositoryException, DatabaseException, WorkflowException, IOException
WorkflowModuleregisterProcessDefinition in interface WorkflowModuletoken - 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.AccessDeniedExceptionIOExceptionpublic void deleteProcessDefinition(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModuledeleteProcessDefinition in interface WorkflowModuletoken - 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.AccessDeniedExceptionpublic ProcessDefinition getProcessDefinition(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulegetProcessDefinition in interface WorkflowModuletoken - 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.AccessDeniedExceptionpublic byte[] getProcessDefinitionImage(String token, long processDefinitionId, String node) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulegetProcessDefinitionImage in interface WorkflowModuletoken - 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.AccessDeniedExceptionpublic Map<String,List<FormElement>> getProcessDefinitionForms(String token, long processDefinitionId) throws ParseException, AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulegetProcessDefinitionForms in interface WorkflowModuletoken - 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.AccessDeniedExceptionpublic ProcessInstance runProcessDefinition(String token, long processDefinitionId, String uuid, List<FormElement> variables) throws WorkflowException, AccessDeniedException, RepositoryException, DatabaseException
WorkflowModulerunProcessDefinition in interface WorkflowModuletoken - 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.WorkflowException - If there is any workflow engine error.RepositoryException - If there is a general repository error.DatabaseException - If there is a general database error.AccessDeniedExceptionpublic ProcessInstance sendProcessInstanceSignal(String token, long processInstanceId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
sendProcessInstanceSignal in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void endProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
endProcessInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void deleteProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
deleteProcessInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<ProcessInstance> findProcessInstances(String token, long processDefinitionId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
findProcessInstances in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<ProcessDefinition> findAllProcessDefinitions(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulefindAllProcessDefinitions in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<ProcessDefinition> findLatestProcessDefinitions(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulefindLatestProcessDefinitions in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic ProcessDefinition findLastProcessDefinition(String token, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulefindLastProcessDefinition in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<ProcessDefinition> findAllProcessDefinitionVersions(String token, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
WorkflowModulefindAllProcessDefinitionVersions in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic ProcessInstance getProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
getProcessInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void suspendProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
suspendProcessInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void resumeProcessInstance(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
resumeProcessInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void addProcessInstanceVariable(String token, long processInstanceId, String name, Object value) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
addProcessInstanceVariable in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void deleteProcessInstanceVariable(String token, long processInstanceId, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
deleteProcessInstanceVariable in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<TaskInstance> findUserTaskInstances(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
findUserTaskInstances in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<TaskInstance> findPooledTaskInstances(String token) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
findPooledTaskInstances in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic List<TaskInstance> findTaskInstances(String token, long processInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
findTaskInstances in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void setTaskInstanceValues(String token, long taskInstanceId, String transitionName, List<FormElement> values) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
setTaskInstanceValues in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void addTaskInstanceComment(String token, long taskInstanceId, String message) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
addTaskInstanceComment in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic TaskInstance getTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
getTaskInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void setTaskInstanceActorId(String token, long taskInstanceId, String actorId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
setTaskInstanceActorId in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void addTaskInstanceVariable(String token, long taskInstanceId, String name, Object value) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
addTaskInstanceVariable in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void deleteTaskInstanceVariable(String token, long taskInstanceId, String name) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
deleteTaskInstanceVariable in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void startTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
startTaskInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void endTaskInstance(String token, long taskInstanceId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
endTaskInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void suspendTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
suspendTaskInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void resumeTaskInstance(String token, long taskInstanceId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
resumeTaskInstance in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic Token getToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
getToken in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void addTokenComment(String token, long tokenId, String message) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
addTokenComment in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void suspendToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
suspendToken in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void resumeToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
resumeToken in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic Token sendTokenSignal(String token, long tokenId, String transitionName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
sendTokenSignal in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void setTokenNode(String token, long tokenId, String nodeName) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
setTokenNode in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionpublic void endToken(String token, long tokenId) throws AccessDeniedException, RepositoryException, DatabaseException, WorkflowException
endToken in interface WorkflowModuleAccessDeniedExceptionRepositoryExceptionDatabaseExceptionWorkflowExceptionCopyright © 2018 Open Knowledge Management System S.L.. All rights reserved.