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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WSWorkflowHistory
addNote(String sid, String taskId, String note)
Adds a new notevoid
appendDocuments(String sid, String taskId, Long[] docIds)
Appends new documents to the workflowvoid
claim(String sid, String taskId)
Claims a taskvoid
complete(String sid, String taskId, String transition)
Completes a task taking a given transitionWSWorkflowHistory[]
getHistories(String sid, String instanceId, String event)
Gets the histories of a workflow instanceWSWorkflowTask[]
getTasksAssignedToMe(String sid)
Retrieves the tasks assigned to the current userWSWorkflowTask[]
getTasksICanOwn(String sid)
Retrieves the tasks that can be owned by the current userString[]
getWorkflows(String sid)
Lists the available workflowsvoid
reassign(String sid, String taskId, long userId)
Reassigns a task to another userString
startWorkflow(String sid, String workflow, String tag, long[] docIds)
Launches a new workflow instancevoid
unclaim(String sid, String taskId)
Turns a task back to pool
-
-
-
Method Detail
-
claim
void claim(String sid, String taskId) throws Exception
Claims a task- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the task- Throws:
Exception
- error in the server
-
complete
void complete(String sid, String taskId, String transition) throws Exception
Completes a task taking a given transition- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the tasktransition
- name of the transition- Throws:
Exception
- error in the server
-
unclaim
void unclaim(String sid, String taskId) throws Exception
Turns a task back to pool- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the task- Throws:
Exception
- error in the server
-
reassign
void reassign(String sid, String taskId, long userId) throws Exception
Reassigns a task to another user- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskuserId
- identifier of the user- Throws:
Exception
- error in the server
-
addNote
WSWorkflowHistory addNote(String sid, String taskId, String note) throws Exception
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:
Exception
- error in the server
-
getTasksAssignedToMe
WSWorkflowTask[] getTasksAssignedToMe(String sid) throws Exception
Retrieves the tasks assigned to the current user- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
Exception
- error in the server
-
getTasksICanOwn
WSWorkflowTask[] getTasksICanOwn(String sid) throws Exception
Retrieves the tasks that can be owned by the current user- Parameters:
sid
- identifier of the session- Returns:
- list of tasks
- Throws:
Exception
- error in the server
-
getHistories
WSWorkflowHistory[] getHistories(String sid, String instanceId, String event) throws Exception
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:
Exception
- error in the server
-
appendDocuments
void appendDocuments(String sid, String taskId, Long[] docIds) throws Exception
Appends new documents to the workflow- Parameters:
sid
- identifier of the sessiontaskId
- identifier of the taskdocIds
- identifiers of the documents to append- Throws:
Exception
- error in the server
-
getWorkflows
String[] getWorkflows(String sid) throws Exception
Lists the available workflows- Parameters:
sid
- identifier of the session- Returns:
- list of the workflow names
- Throws:
Exception
- error in the server
-
startWorkflow
String startWorkflow(String sid, String workflow, String tag, long[] docIds) throws Exception
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:
Exception
- error in the server
-
-