Interface ManualWorkflowSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, WorkflowManagementSession

public interface ManualWorkflowSession
extends WorkflowManagementSession

This session provides methods for manually moving work through a workflow.

Method Summary

Modifier and Type	Method	Description
void	advanceWork(Id processId, Id workId)	Advances work to a next step in the workflow based on the work and the input conditions of the next steps.
void	assignWorkToStep(Id processId, Id workId, Id stepId)	Manually assigns a work to a step.
boolean	canOperateWorkflow()	Tests if this user can operate a workflow.
boolean	canOperateWorkflowForProcess(Id processId)	Tests if this user can operate a workflow.
StepList	getAllValidStepsForWork(Id processId, Id workId)	Gets the all valid steps in this process the given work can be manually assigned and includes the steps previous to the work's current step.
StepList	getValidNextStepsForWork(Id processId, Id workId)	Gets the valid next steps in this process in which the given work can be manually advanced.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface WorkflowManagementSession

cancelWork, canManageWorkflow, canManageWorkflowForProcess, getOffice, getOfficeId, resumeWork, suspendWork

Modifier and Type	Method	Description
void	cancelWork(Id processId, Id workId)	Cancels a work in this process removing it from the workflow.
boolean	canManageWorkflow()	Tests if this user can manage a workflow.
boolean	canManageWorkflowForProcess(Id processId)	Tests if this user can manage a workflow for a process.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	resumeWork(Id processId, Id workId)	Resumes a work in this process.
void	suspendWork(Id processId, Id workId)	Suspends a work in this process leaving it at its current step.

Method Details

canOperateWorkflow

boolean canOperateWorkflow()

Tests if this user can operate a workflow. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer workflow operations to unauthorized users.

Returns:

false if workflow operation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canOperateWorkflowForProcess

boolean canOperateWorkflowForProcess(Id processId)

Tests if this user can operate a workflow. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer workflow operations to unauthorized users.

Parameters:

processId - a process Id

Returns:

false if workflow operation methods are not authorized, true otherwise

Throws:

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

advanceWork

void advanceWork(Id processId,
 Id workId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Advances work to a next step in the workflow based on the work and the input conditions of the next steps.

Parameters:

processId - a process Id

workId - a work Id

Throws:

NotFoundException - processId is not found or workId is in process

NullArgumentException - processId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getValidNextStepsForWork

StepList getValidNextStepsForWork(Id processId,
 Id workId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the valid next steps in this process in which the given work can be manually advanced.

Parameters:

processId - a process Id

workId - a work Id

Returns:

the returned Step list

Throws:

NotFoundException - processId is not found or workId is in process

NullArgumentException - processId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAllValidStepsForWork

StepList getAllValidStepsForWork(Id processId,
 Id workId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the all valid steps in this process the given work can be manually assigned and includes the steps previous to the work's current step.

Parameters:

processId - a process Id

workId - a work Id

Returns:

the returned Step list

Throws:

NotFoundException - processId is not found or workId is in process

NullArgumentException - processId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignWorkToStep

void assignWorkToStep(Id processId,
 Id workId,
 Id stepId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Manually assigns a work to a step.

Parameters:

processId - a process Id

workId - a work Id

stepId - a step Id

Throws:

NotFoundException - processId is not found or workId or stepId is not found in this process

NullArgumentException - processId, workId , or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.