com.logicaldoc.gui.frontend.client.services

Interface WorkflowService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath(value="workflow")
public interface WorkflowService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Workflow Service. This service gives all needed methods to handle workflows.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendDocuments(String sid, String taskId, Long[] docIds) Appends to the workflow of the given taskId the documents with the given doc ids.
void	applyTriggersToTree(String sid, long rootId) Applies the triggers on a root folder to all the subtree
GUIWorkflow	claimTask(String sid, String taskId, String userId) The given user take the ownership of the task.
int	countActiveUserTasks(String sid, String username) Counts all the tasks assigned to the given user.
void	delete(String sid, String workflowName) Deletes a given workflow
void	deleteInstance(String sid, String id) Deletes a given workflow instance
void	deleteTrigger(String sid, long id) Deletes a workflow trigger
void	deploy(String sid, GUIWorkflow workflow) Deploys a given workflow
void	endTask(String sid, String taskId, String transitionName) Ends a task invoking the transition.
GUIWorkflow	get(String sid, String workflowName) Loads a given workflow from the database
GUIWorkflow	getWorkflowDetailsByTask(String sid, String taskId) Retrieves all the info of the workflow of the given task.
GUIWorkflow	importSchema(String sid) Imports a new workflow schema.
GUIWorkflow[]	list(String sid) Lists all the workflows on the database
GUIWorkflow	reassignTask(String sid, String taskId, String userId) The task is assigned to another user
GUIWorkflow	save(String sid, GUIWorkflow workflow) Creates or updates a workflow
void	saveTrigger(String sid, String folderId, String workflowId, String templateId, int startAtCheckin) Save a new workflow trigger on the given folder with the given workflowId and templateId.
void	startWorkflow(String sid, String workflowName, String workflowDescription, long[] docIds) Start a workflow with the given name and associated to the documents with the given doc ids.
void	turnBackTaskToPool(String sid, String taskId) The task is reassigned to the pooled users.
void	undeploy(String sid, String workflowName) Undeploys a given workflow

Method Detail

get

GUIWorkflow get(String sid,
              String workflowName)
                throws InvalidSessionException

Loads a given workflow from the database

Throws:

InvalidSessionException

delete

void delete(String sid,
          String workflowName)
            throws InvalidSessionException

Deletes a given workflow

Throws:

InvalidSessionException

deleteInstance

void deleteInstance(String sid,
                  String id)
                    throws InvalidSessionException

Deletes a given workflow instance

Throws:

InvalidSessionException

importSchema

GUIWorkflow importSchema(String sid)
                         throws InvalidSessionException

Imports a new workflow schema.

Throws:

InvalidSessionException

save

GUIWorkflow save(String sid,
               GUIWorkflow workflow)
                 throws InvalidSessionException

Creates or updates a workflow

Throws:

InvalidSessionException

deploy

void deploy(String sid,
          GUIWorkflow workflow)
            throws InvalidSessionException

Deploys a given workflow

Throws:

InvalidSessionException

undeploy

void undeploy(String sid,
            String workflowName)
              throws InvalidSessionException

Undeploys a given workflow

Throws:

InvalidSessionException

list

GUIWorkflow[] list(String sid)
                   throws InvalidSessionException

Lists all the workflows on the database

Throws:

InvalidSessionException

deleteTrigger

void deleteTrigger(String sid,
                 long id)
                   throws InvalidSessionException

Deletes a workflow trigger

Throws:

InvalidSessionException

applyTriggersToTree

void applyTriggersToTree(String sid,
                       long rootId)
                         throws InvalidSessionException

Applies the triggers on a root folder to all the subtree

Throws:

InvalidSessionException

saveTrigger

void saveTrigger(String sid,
               String folderId,
               String workflowId,
               String templateId,
               int startAtCheckin)
                 throws InvalidSessionException

Save a new workflow trigger on the given folder with the given workflowId and templateId.

Throws:

InvalidSessionException

startWorkflow

void startWorkflow(String sid,
                 String workflowName,
                 String workflowDescription,
                 long[] docIds)
                   throws InvalidSessionException

Start a workflow with the given name and associated to the documents with the given doc ids.

Throws:

InvalidSessionException

getWorkflowDetailsByTask

GUIWorkflow getWorkflowDetailsByTask(String sid,
                                   String taskId)
                                     throws InvalidSessionException

Retrieves all the info of the workflow of the given task.

Throws:

InvalidSessionException

claimTask

GUIWorkflow claimTask(String sid,
                    String taskId,
                    String userId)
                      throws InvalidSessionException

The given user take the ownership of the task. If the task is already claimed you cannot claim again.

Throws:

InvalidSessionException

reassignTask

GUIWorkflow reassignTask(String sid,
                       String taskId,
                       String userId)
                         throws InvalidSessionException

The task is assigned to another user

Throws:

InvalidSessionException

turnBackTaskToPool

void turnBackTaskToPool(String sid,
                      String taskId)
                        throws InvalidSessionException

The task is reassigned to the pooled users.

Throws:

InvalidSessionException

endTask

void endTask(String sid,
           String taskId,
           String transitionName)
             throws InvalidSessionException

Ends a task invoking the transition.

Throws:

InvalidSessionException

countActiveUserTasks

int countActiveUserTasks(String sid,
                       String username)
                         throws InvalidSessionException

Counts all the tasks assigned to the given user.

Throws:

InvalidSessionException

appendDocuments

void appendDocuments(String sid,
                   String taskId,
                   Long[] docIds)
                     throws InvalidSessionException

Appends to the workflow of the given taskId the documents with the given doc ids.

Throws:

InvalidSessionException