public interface Step extends OsidGovernator, Subjugateable
A Step
is an element in a Process in which Work is
processed. The workers in this Step
are represented by
Resources
or Resource
groups. The input
States
list the states of Work
that are
valid to be accepted into this Step.
Successful processing
of the Work
result in a single next State
that determines the valid next Steps
in the Process.
Modifier and Type | Method and Description |
---|---|
IdList |
getInputStateIds()
Gets the
Ids of the valid states entering this step. |
StateList |
getInputStates()
Gets the valid states to enter this step.
|
State |
getNextState()
Gets the state of the work upon completing this step.
|
Id |
getNextStateId()
Gets the
Id of the state of the work upon completing
this step. |
Process |
getProcess()
Gets the process.
|
Id |
getProcessId()
Gets the
Id of the process. |
IdList |
getResourceIds()
Gets the
Ids of the resources working in this step. |
ResourceList |
getResources()
Gets the resources working in this step.
|
StepRecord |
getStepRecord(Type stepRecordType)
Gets the step record corresponding to the given
Step
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
Id getProcessId()
Id
of the process. Id
mandatory
- This method must be implemented. Process getProcess() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getResourceIds()
Ids
of the resources working in this step. Ids
mandatory
- This method must be implemented. ResourceList getResources() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getInputStateIds()
Ids
of the valid states entering this step. Ids
mandatory
- This method must be implemented. StateList getInputStates() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getNextStateId()
Id
of the state of the work upon completing
this step. Id
mandatory
- This method must be implemented. State getNextState() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. StepRecord getStepRecord(Type stepRecordType) throws OperationFailedException
Step
record Type.
This method is used to retrieve an object
implementing the requested record. The stepRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(stepRecordType)
is true
.stepRecordType
- the type of step record to retrieveNullArgumentException
- stepRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepRecordType)
is false
mandatory
- This method must be implemented.