public interface StepProcessor extends OsidProcessor
A StepProcessor
describes the rules for managing the
behavior of a step.
Modifier and Type | Method and Description |
---|---|
StepProcessorRecord |
getStepProcessorRecord(Type stepProcessorRecordType)
Gets the step processor record corresponding to the given
StepProcessor record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
StepProcessorRecord getStepProcessorRecord(Type stepProcessorRecordType) throws OperationFailedException
StepProcessor
record Type.
This method is used
to retrieve an object implementing the requested record. The
stepProcessorRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(stepProcessorRecordType)
is true
.stepProcessorRecordType
- the type of step processor record to
retrieveNullArgumentException
- stepProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stepProcessorRecordType)
is false
mandatory
- This method must be implemented.