Package com.logicaldoc.workflow.webservice.soap.client

Class SoapWorkflowClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<WorkflowService>

com.logicaldoc.workflow.webservice.soap.client.SoapWorkflowClient

All Implemented Interfaces:

WorkflowService

public class SoapWorkflowClient
extends com.logicaldoc.webservice.soap.client.SoapClient<WorkflowService>
implements WorkflowService

Simple client for the Workflow webservice

Since:

7.6

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapWorkflowClient(String endpoint)

Method Summary

Modifier and Type	Method	Description
WSWorkflowHistory	addNote(String sid, String taskId, String note)	Adds a new note
void	appendDocuments(String sid, String taskId, List<Long> docIds)	Appends new documents to the workflow
void	claim(String sid, String taskId)	Claims a task
void	complete(String sid, String taskId, String transition)	Completes a task taking a given transition
List<WSWorkflowHistory>	getHistories(String sid, String instanceId, String event)	Gets the histories of a workflow instance
List<WSWorkflowTask>	getTasksAssignedToMe(String sid)	Retrieves the tasks assigned to the current user
List<WSWorkflowTask>	getTasksICanOwn(String sid)	Retrieves the tasks that can be owned by the current user
List<String>	getWorkflows(String sid)	Lists the available workflows
void	reassign(String sid, String taskId, long userId)	Reassigns a task to another user
String	startWorkflow(String sid, String workflow, String tag, String color, List<Long> docIds)	Launches a new workflow instance
void	unclaim(String sid, String taskId)	Turns a task back to pool

Methods inherited from class java.lang.Object

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

Constructor Details

SoapWorkflowClient

public SoapWorkflowClient(String endpoint)

Method Details

claim

public void claim(String sid,
 String taskId)
           throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.core.PersistenceException,
FeatureNotEnabledException,
com.logicaldoc.webservice.WebserviceException

Description copied from interface: WorkflowService

Claims a task

Specified by:

claim in interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

com.logicaldoc.core.PersistenceException - Error in the data layer

FeatureNotEnabledException - Feature not enabled in the license

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

transition - name of the transition

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.logicaldoc.core.PersistenceException - Error in the data layer

WorkflowValidationException - 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 interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

note - text of the note

Returns:

the event created for this note

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

Returns:

list of tasks

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

Returns:

list of tasks

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

instanceId - identifier of the workflow instance

event - optional filter on a specific event type

Returns:

the histories

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

docIds - identifiers of the documents to append

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

Returns:

list of the workflow names

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

workflow - name of the workflow

tag - a tag you can assign to the new instance

docIds - 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 authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 interface WorkflowService

Parameters:

sid - identifier of the session

taskId - identifier of the task

userId - identifier of the user

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.logicaldoc.core.PersistenceException - Error in the data layer