public interface State extends OsidObject
A State
represents a stage in a process.
Modifier and Type | Method and Description |
---|---|
StateRecord |
getStateRecord(Type stateRecordType)
Gets the state record corresponding to the given
State
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
StateRecord getStateRecord(Type stateRecordType) throws OperationFailedException
State
record Type.
This method is used to retrieve an object
implementing the requested record. The stateRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(stateRecordType)
is true
.stateRecordType
- the state record typeNullArgumentException
- stateRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stateRecordType)
is false
mandatory
- This method must be implemented.