Interface WorkflowSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface WorkflowSession
extends OsidSession

This session provides methods for looking at a workflow.

Method Summary

Modifier and Type	Method	Description
boolean	canAccessWorkflow()	Tests if this user can access a workflow.
boolean	canAccessWorkflowForProcess(Id processId)	Tests if this user can access a workflow in a process.
WorkList	getCanceledWork(Id processId)	Gets the work canceled in a process.
WorkList	getCanceledWorkByDate(Id processId, DateTime start, DateTime end)	Gets the work canceled in a process within the given date range inclusive.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
ProcessList	getProcessesForWork(Id workId)	Gets the processes a work is in.
Step	getStepForWork(Id processId, Id workId)	Gets the step corresponding to a work in a process.
WorkList	getSuspendedWork(Id processId)	Gets all the suspended work in a process.
WorkList	getSuspendedWorkAtStep(Id stepId)	Gets the suspended work at a step in a process.
WorkList	getWorkAtStep(Id stepId)	Getsall the work at a step in a process.

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.

Method Details

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
          throws OperationFailedException,
PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessWorkflow

boolean canAccessWorkflow()

Tests if this user can access 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 initiation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAccessWorkflowForProcess

boolean canAccessWorkflowForProcess(Id processId)

Tests if this user can access a workflow in a process. 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 initiation methods are not authorized, true otherwise

Throws:

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

getProcessesForWork

ProcessList getProcessesForWork(Id workId)
                         throws OperationFailedException,
PermissionDeniedException

Gets the processes a work is in.

Parameters:

workId - a work Id

Returns:

the Processes

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepForWork

Step getStepForWork(Id processId,
 Id workId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the step corresponding to a work in a process.

Parameters:

processId - a process Id

workId - a work Id

Returns:

the returned Step

Throws:

NotFoundException - processId not found or workId is not active in the process

NullArgumentException - processId or workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkAtStep

WorkList getWorkAtStep(Id stepId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Getsall the work at a step in a process.

Parameters:

stepId - a step Id

Returns:

the returned Work List

Throws:

NotFoundException - stepId is not found

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSuspendedWork

WorkList getSuspendedWork(Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all the suspended work in a process.

Parameters:

processId - a process Id

Returns:

the returned Work List

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSuspendedWorkAtStep

WorkList getSuspendedWorkAtStep(Id stepId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the suspended work at a step in a process.

Parameters:

stepId - a step Id

Returns:

the returned Work List

Throws:

NotFoundException - stepId is not found

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanceledWork

WorkList getCanceledWork(Id processId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the work canceled in a process.

Parameters:

processId - a process Id

Returns:

the returned Work List

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanceledWorkByDate

WorkList getCanceledWorkByDate(Id processId,
 DateTime start,
 DateTime end)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the work canceled in a process within the given date range inclusive.

Parameters:

processId - a process Id

start - start range

end - end range

Returns:

the returned Work List

Throws:

InvalidArgumentException - start is greater than end

NotFoundException - processId not found

NullArgumentException - processId, start or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.