Package com.logicaldoc.workflow.webservice.soap

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 Type	Method	Description
WSWorkflowHistory	addNote(String sid, String taskId, String note)	Adds a new note
void	appendDocuments(String sid, String taskId, 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
WSWorkflowHistory[]	getHistories(String sid, String instanceId, String event)	Gets the histories of a workflow instance
WSWorkflowTask[]	getTasksAssignedToMe(String sid)	Retrieves the tasks assigned to the current user
WSWorkflowTask[]	getTasksICanOwn(String sid)	Retrieves the tasks that can be owned by the current user
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, long[] docIds)	Launches a new workflow instance
void	unclaim(String sid, String taskId)	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 session

taskId - identifier of the task

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

Completes a task taking a given transition

Parameters:

sid - identifier of the session

taskId - identifier of the task

transition - name of the transition

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

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 session

taskId - identifier of the task

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 session

taskId - identifier of the task

userId - identifier of the user

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

com.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 session

taskId - identifier of the task

note - text of the note

Returns:

the event created for this note

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

getTasksAssignedToMe

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 layer

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

getTasksICanOwn

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 layer

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

getHistories

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 session

instanceId - identifier of the workflow instance

event - optional filter on a specific event type

Returns:

the histories

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

appendDocuments

void appendDocuments(String sid,
 String taskId,
 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 session

taskId - identifier of the task

docIds - identifiers of the documents to append

Throws:

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

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

getWorkflows

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 layer

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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

startWorkflow

String startWorkflow(String sid,
 String workflow,
 String tag,
 String color,
 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 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.PersistenceException - Error in the data layer

FeatureNotEnabledException - Feature not enabled in the license

com.logicaldoc.webservice.WebserviceException - Webservice error

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