Class SoapWorkflowService
java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.workflow.webservice.soap.endpoint.SoapWorkflowService
- All Implemented Interfaces:
WorkflowService
public class SoapWorkflowService
extends com.logicaldoc.webservice.AbstractService
implements WorkflowService
Implementation of the WorkflowService
- Since:
- 7.6
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
-
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 poolMethods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession
-
Constructor Details
-
SoapWorkflowService
public SoapWorkflowService()
-
-
Method Details
-
claim
public void claim(String sid, String taskId) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException Description copied from interface:WorkflowService
Claims a task- Specified by:
claim
in interfaceWorkflowService
- 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.core.security.authentication.AuthenticationException
- The user has not been authenticatedcom.logicaldoc.webservice.WebserviceException
- Webservice error
-
complete
public 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 Description copied from interface:WorkflowService
Completes a task taking a given transition- Specified by:
complete
in interfaceWorkflowService
- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the tasktransition
- name of the transition- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layerWorkflowValidationException
- The task cannot be completed due to validation failures
-
unclaim
public void unclaim(String sid, String taskId) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Turns a task back to pool- Specified by:
unclaim
in interfaceWorkflowService
- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the task- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
reassign
public void reassign(String sid, String taskId, long userId) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Reassigns a task to another user- Specified by:
reassign
in interfaceWorkflowService
- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskuserId
- identifier of the user- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
addNote
public WSWorkflowHistory addNote(String sid, String taskId, String note) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Adds a new note- Specified by:
addNote
in interfaceWorkflowService
- 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.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
getHistories
public 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 Description copied from interface:WorkflowService
Gets the histories of a workflow instance- Specified by:
getHistories
in interfaceWorkflowService
- 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.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
appendDocuments
public 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 Description copied from interface:WorkflowService
Appends new documents to the workflow- Specified by:
appendDocuments
in interfaceWorkflowService
- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskdocIds
- identifiers of the documents to append- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
getTasksAssignedToMe
public List<WSWorkflowTask> getTasksAssignedToMe(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Retrieves the tasks assigned to the current user- Specified by:
getTasksAssignedToMe
in interfaceWorkflowService
- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
getTasksICanOwn
public List<WSWorkflowTask> getTasksICanOwn(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Retrieves the tasks that can be owned by the current user- Specified by:
getTasksICanOwn
in interfaceWorkflowService
- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
getWorkflows
public List<String> getWorkflows(String sid) throws com.logicaldoc.core.security.authentication.AuthenticationException, FeatureNotEnabledException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException Description copied from interface:WorkflowService
Lists the available workflows- Specified by:
getWorkflows
in interfaceWorkflowService
- Parameters:
sid
- identifier of the session- Returns:
- list of the workflow names
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-
startWorkflow
public 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 Description copied from interface:WorkflowService
Launches a new workflow instance- Specified by:
startWorkflow
in interfaceWorkflowService
- 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.security.authentication.AuthenticationException
- The user has not been authenticatedFeatureNotEnabledException
- Feature not enabled in the licensecom.logicaldoc.webservice.WebserviceException
- Webservice errorcom.logicaldoc.core.PersistenceException
- Error in the data layer
-