Interface WorkflowService
- All Known Implementing Classes:
SoapWorkflowClient
,SoapWorkflowService
public interface WorkflowService
Form Web Service definition interface
- Since:
- 7.4.1
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionAdds a new notevoid
appendDocuments
(String sid, String taskId, List<Long> docIds) Appends new documents to the workflowvoid
Claims a taskvoid
Completes a task taking a given transitiongetHistories
(String sid, String instanceId, String event) Gets the histories of a workflow instanceRetrieves the tasks assigned to the current usergetTasksICanOwn
(String sid) Retrieves the tasks that can be owned by the current usergetWorkflows
(String sid) Lists the available workflowsvoid
Reassigns a task to another userLaunches a new workflow instancevoid
Turns a task back to pool
-
Method Details
-
claim
void claim(String sid, String taskId) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException Claims a task- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the task- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
complete
void complete(String sid, String taskId, String transition) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, WorkflowValidationException Completes a task taking a given transition- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the tasktransition
- name of the transition- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedWorkflowValidationException
- The task cannot be completed due to validation failures
-
unclaim
void unclaim(String sid, String taskId) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Turns a task back to pool- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the task- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
reassign
void reassign(String sid, String taskId, long userId) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Reassigns a task to another user- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskuserId
- identifier of the user- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
addNote
WSWorkflowHistory addNote(String sid, String taskId, String note) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Adds a new note- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the tasknote
- text of the note- Returns:
- the event created for this note
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
getTasksAssignedToMe
List<WSWorkflowTask> getTasksAssignedToMe(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Retrieves the tasks assigned to the current user- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
getTasksICanOwn
List<WSWorkflowTask> getTasksICanOwn(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Retrieves the tasks that can be owned by the current user- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
getHistories
List<WSWorkflowHistory> getHistories(String sid, String instanceId, String event) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Gets the histories of a workflow instance- Parameters:
sid
- identifier of the sessioninstanceId
- identifier of the workflow instanceevent
- optional filter on a specific event type- Returns:
- the histories
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
appendDocuments
void appendDocuments(String sid, String taskId, List<Long> docIds) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Appends new documents to the workflow- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskdocIds
- identifiers of the documents to append- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
getWorkflows
List<String> getWorkflows(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Lists the available workflows- Parameters:
sid
- identifier of the session- Returns:
- list of the workflow names
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
startWorkflow
String startWorkflow(String sid, String workflow, String tag, String color, List<Long> docIds) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Launches a new workflow instance- Parameters:
sid
- identifier of the sessionworkflow
- name of the workflowtag
- a tag you can assign to the new instancedocIds
- identifiers of the documents to be appended to the workflow- Returns:
- identifier of the workflow instance
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layerFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-