public interface WorkflowInitiationSession extends OsidSession
This session provides methods for initiating a workflow.
Modifier and Type | Method and Description |
---|---|
boolean |
canInitiateWorkflow()
Tests if this user can initiate a workflow.
|
boolean |
canInitiateWorkflowForProcess(Id processId)
Tests if this user can initiate a workflow in a process.
|
WorkList |
getAvailableWork(Id processId)
Gets the list of available work for this workflow.
|
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
startWorkflow(Id processId,
Id workId)
Starts a work in the workflow at the initial step of the 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 canInitiateWorkflow()
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 canInitiateWorkflowForProcess(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. WorkList getAvailableWork(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Work
that is compatible with this Process
but not currently part of this Process.
processId
- a process Id
Work
listNotFoundException
- processId
is not
foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void startWorkflow(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
NotFoundException
- processId
or
workId
is not foundNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.