Package com.logicaldoc.workflow.automation

Class WorkflowTool

java.lang.Object

com.logicaldoc.workflow.automation.WorkflowTool

public class WorkflowTool
extends Object

Utility methods to handle workflows from Velocity

Since:

7.3

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
WorkflowTool()

Method Summary

Modifier and Type	Method	Description
WorkflowHistory	addNote(String processId, String taskName, String note)	Adds a new note
WorkflowHistory	addNote(org.activiti.engine.task.Task task, String note)	Adds a new note
void	appendDocument(org.activiti.engine.task.Task task, long docId, String username)	Appends a document to the given workflow
void	claim(org.activiti.engine.task.Task task, com.logicaldoc.core.security.User user)
void	claim(org.activiti.engine.task.Task task, String username)	Claims the given task for a defined user
String	claimUrl(org.activiti.engine.task.Task task, com.logicaldoc.core.security.User assignee)
String	claimUrl(org.activiti.engine.task.Task task, String assignee)
void	complete(org.activiti.engine.task.Task task, String transition)	Completes the given task using a specific transition
String	completeUrl(org.activiti.engine.task.Task task, String transition, com.logicaldoc.core.security.User assignee)
String	completeUrl(org.activiti.engine.task.Task task, String transition, String username)
void	deleteInstance(String processInstanceId)	Deletes a given workflow process instance
List<WorkflowHistory>	getHistories(String processId, String event)	Retrieve the list of events of the current workflow
WorkflowHistory	getLastHistory(String processId, String event)	Retrieve the last history of a given type
List<WorkflowHistory>	getNotes(String processId)	Gets the notes of the given workflow
com.logicaldoc.core.security.User	getUser(String username)
Object	getVariable(String processInstanceId, String name)	Gets the value of a variable of the specified workflow instance
Map<String,Object>	getVariables(String processInstanceId)	Gets the variables of the specified workflow instance
void	removeDocument(org.activiti.engine.task.Task task, long docId, String username)	Removes a document to the given workflow
void	setVariable(String processInstanceId, String name, Object value)	Sets the value of a variable of the specified workflow instance
String	startWorkflow(String workflowName, long docId, String username)
String	startWorkflow(String workflowName, String tag, long docId, String username)
String	startWorkflow(String workflowName, String tag, Collection<Long> docIds, String username)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowTool

public WorkflowTool()

Method Detail

complete

public void complete(org.activiti.engine.task.Task task,
                     String transition)

Completes the given task using a specific transition

Parameters:

task - the task to complete

transition - name of the transition to take

getVariables

public Map<String,Object> getVariables(String processInstanceId)

Gets the variables of the specified workflow instance

Parameters:

processInstanceId - identifier of the current workflow instance

Returns:

the map(name/value) of the variables

setVariable

public void setVariable(String processInstanceId,
                        String name,
                        Object value)

Sets the value of a variable of the specified workflow instance

Parameters:

processInstanceId - identifier of the workflow instance

name - name of the variable

value - value of the variable

getVariable

public Object getVariable(String processInstanceId,
                          String name)

Gets the value of a variable of the specified workflow instance

Parameters:

processInstanceId - identifier of the workflow instance

name - name of the variable

Returns:

value value of the variable

appendDocument

public void appendDocument(org.activiti.engine.task.Task task,
                           long docId,
                           String username)
                    throws com.logicaldoc.gui.common.client.ServerException,
                           com.logicaldoc.core.PersistenceException

Appends a document to the given workflow

Parameters:

task - the task

docId - identifier of the document to append

username - the user in whose name the method is run (it can be null)

Throws:

com.logicaldoc.gui.common.client.ServerException - a generic error

com.logicaldoc.core.PersistenceException - error in the database

removeDocument

public void removeDocument(org.activiti.engine.task.Task task,
                           long docId,
                           String username)
                    throws com.logicaldoc.gui.common.client.ServerException,
                           com.logicaldoc.core.PersistenceException

Removes a document to the given workflow

Parameters:

task - the task

docId - identifier of the document to remove

username - the user in whose name the method is run (it can be null)

Throws:

com.logicaldoc.gui.common.client.ServerException - a generic error

com.logicaldoc.core.PersistenceException - error in the database

getHistories

public List<WorkflowHistory> getHistories(String processId,
                                          String event)

Retrieve the list of events of the current workflow

Parameters:

processId - identifier of the current process

event - optional filter on the type of event

Returns:

list of histories

getNotes

public List<WorkflowHistory> getNotes(String processId)

Gets the notes of the given workflow

Parameters:

processId - identifier of the current process

Returns:

list of notes

getLastHistory

public WorkflowHistory getLastHistory(String processId,
                                      String event)

Retrieve the last history of a given type

Parameters:

processId - identifier of the current process

event - optional name of the event

Returns:

the found event

claim

public void claim(org.activiti.engine.task.Task task,
                  String username)
           throws com.logicaldoc.core.PersistenceException

Claims the given task for a defined user

Parameters:

task - the task

username - username of the claimer

Throws:

com.logicaldoc.core.PersistenceException - error in the database

claim

public void claim(org.activiti.engine.task.Task task,
                  com.logicaldoc.core.security.User user)
           throws com.logicaldoc.core.PersistenceException

Throws:

com.logicaldoc.core.PersistenceException

addNote

public WorkflowHistory addNote(org.activiti.engine.task.Task task,
                               String note)
                        throws com.logicaldoc.gui.common.client.ServerException

Adds a new note

Parameters:

task - the task

note - text of the note to add

Returns:

the event produced by the note

Throws:

com.logicaldoc.gui.common.client.ServerException - generic error

addNote

public WorkflowHistory addNote(String processId,
                               String taskName,
                               String note)
                        throws com.logicaldoc.gui.common.client.ServerException

Adds a new note

Parameters:

processId - identifier of the current process

taskName - name of the task

note - text of the note to add

Returns:

the event generated by the note

Throws:

com.logicaldoc.gui.common.client.ServerException - generic error

completeUrl

public String completeUrl(org.activiti.engine.task.Task task,
                          String transition,
                          com.logicaldoc.core.security.User assignee)
                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

completeUrl

public String completeUrl(org.activiti.engine.task.Task task,
                          String transition,
                          String username)
                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

claimUrl

public String claimUrl(org.activiti.engine.task.Task task,
                       com.logicaldoc.core.security.User assignee)
                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

claimUrl

public String claimUrl(org.activiti.engine.task.Task task,
                       String assignee)
                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

startWorkflow

public String startWorkflow(String workflowName,
                            long docId,
                            String username)
                     throws com.logicaldoc.core.PersistenceException

Throws:

com.logicaldoc.core.PersistenceException

startWorkflow

public String startWorkflow(String workflowName,
                            String tag,
                            long docId,
                            String username)
                     throws com.logicaldoc.core.PersistenceException

Throws:

com.logicaldoc.core.PersistenceException

startWorkflow

public String startWorkflow(String workflowName,
                            String tag,
                            Collection<Long> docIds,
                            String username)
                     throws com.logicaldoc.core.PersistenceException

Throws:

com.logicaldoc.core.PersistenceException

getUser

public com.logicaldoc.core.security.User getUser(String username)

deleteInstance

public void deleteInstance(String processInstanceId)

Deletes a given workflow process instance

Parameters:

processInstanceId - identifier of the instance to delete