com.fatwire.services

Interface WorkflowService

All Superinterfaces:

Service

@Exported
public interface WorkflowService
extends Service

The Workflow Service is the interface providing services related to a workflow.

Method Summary

Modifier and Type	Method and Description
List<AssignmentBean>	getAssignments() Returns a list containing the assignments for the specified user.
WorkflowBean	getWorkflow(long processId) Returns the workflow for the specified process identifier.
boolean	startWorkFlow(AssetId assetId, Long startmenuId, WorkflowBean workflow, String comment, Map<RoleBean,List<UserBean>> roleUserMapping) Sets the specified asset assignment into the specified workflow.

Methods inherited from interface com.fatwire.services.Service

getManager, getResponse, setManager

Method Detail

getAssignments

List<AssignmentBean> getAssignments()
                             throws ServiceException

Returns a list containing the assignments for the specified user.

Returns:

the list of assignments.

Throws:

ServiceException - wraps any exception underlying the service call.

getWorkflow

WorkflowBean getWorkflow(long processId)
                  throws ServiceException

Returns the workflow for the specified process identifier.

Parameters:

processId - the identifier for the workflow process.

Returns:

the workflow.

Throws:

ServiceException - wraps any exception underlying the service call.

startWorkFlow

boolean startWorkFlow(AssetId assetId,
                      Long startmenuId,
                      WorkflowBean workflow,
                      String comment,
                      Map<RoleBean,List<UserBean>> roleUserMapping)
               throws ServiceException

Sets the specified asset assignment into the specified workflow. Returns true if the asset assignment could be successfully set into the workflow.

Parameters:

assetId - an asset id

startmenuId - a start menu id

comment - a comment

roleUserMapping - a user role mapping

workflow - the workflow in which asset asset needs to be set.

Returns:

true if the asset could be successfully set into the workflow. false otherwise.

Throws:

ServiceException - wraps any exception underlying the service call.