public interface WorkflowSession extends OsidSession
This session provides methods for looking at a workflow.
Modifier and Type | Method and 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.
|
WorkflowEventList |
getStatusesForWork(Id workId)
Gets the statuses of the work across all processes.
|
WorkflowEventList |
getStatusesForWorks(Id processId,
IdList workIds)
Gets the status of a works in a process.
|
WorkflowEvent |
getStatusForWork(Id processId,
Id workId)
Gets the status of a work in a process.
|
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAccessWorkflow()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer workflow operations to
unauthorized users. false
if workflow initiation methods are not
authorized, true
otherwisemandatory
- This method must be implemented. boolean canAccessWorkflowForProcess(Id processId)
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer workflow operations to
unauthorized users.processId
- a process Id false
if workflow initiation methods are not
authorized, true
otherwiseNullArgumentException
- processId
is
null
mandatory
- This method must be implemented. ProcessList getProcessesForWork(Id workId) throws OperationFailedException, PermissionDeniedException
workId
- a work Id
Processes
NullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. Step getStepForWork(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
Step
NotFoundException
- processId
not found
or workId
is not active in the processNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkList getWorkAtStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepId
- a step Id
Work
ListNotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkList getSuspendedWork(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
Work
ListNotFoundException
- processId
not foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkList getSuspendedWorkAtStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepId
- a step Id
Work
ListNotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkList getCanceledWork(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
Work
ListNotFoundException
- processId
not foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkList getCanceledWorkByDate(Id processId, DateTime start, DateTime end) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
start
- start rangeend
- end range Work
ListInvalidArgumentException
- start
is
greater than end
NotFoundException
- processId
not foundNullArgumentException
- processId, start
or end
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkflowEventList getStatusesForWork(Id workId) throws OperationFailedException, PermissionDeniedException
workId
- a work Id
NullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkflowEvent getStatusForWork(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
NotFoundException
- processId
not found
or workId
is not active in the processNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. WorkflowEventList getStatusesForWorks(Id processId, IdList workIds) throws OperationFailedException, PermissionDeniedException
processId
- a process Id
workIds
- a list of work Ids
NullArgumentException
- processId
or
workIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.