public interface ManualWorkflowSession extends WorkflowManagementSession
This session provides methods for manually moving work through a workflow.
Modifier and Type | Method and 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.
|
cancelWork, canManageWorkflow, canManageWorkflowForProcess, getOffice, getOfficeId, resumeWork, suspendWork
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canOperateWorkflow()
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 operation methods are not
authorized, true
otherwisemandatory
- This method must be implemented. boolean canOperateWorkflowForProcess(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 operation methods are not
authorized, true
otherwiseNullArgumentException
- processId
is
null
mandatory
- This method must be implemented. void advanceWork(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
NotFoundException
- processId
is not
found or workId
is in processNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepList getValidNextStepsForWork(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
Step
listNotFoundException
- processId
is not
found or workId
is in processNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepList getAllValidStepsForWork(Id processId, Id workId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
Step
listNotFoundException
- processId
is not
found or workId
is in processNullArgumentException
- processId
or
workId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void assignWorkToStep(Id processId, Id workId, Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- a process Id
workId
- a work Id
stepId
- a step Id
NotFoundException
- processId
is not
found or workId
or stepId
is not
found in this processNullArgumentException
- processId, workId,
or stepId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.