public interface Chain extends OsidObject
An Chain
is a chain resource. A chain is inactive if the
input is disabled.
Modifier and Type | Method and Description |
---|---|
ChainRecord |
getChainRecord(Type chainRecordType)
Gets the chain record corresponding to the given
Chain
record Type. |
boolean |
isFifo()
Tests if elements are appended to the end of the chain.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
boolean isFifo()
true
if elements are appended to the end of the
chain, false
if elements are added to the top
of the chainmandatory
- This method must be implemented. ChainRecord getChainRecord(Type chainRecordType) throws OperationFailedException
Chain
record Type.
This method is used to retrieve an object
implementing the requested record. The chainRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(chainRecordType)
is true
.chainRecordType
- the type of chain record to retrieveNullArgumentException
- chainRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(chainRecordType)
is false
mandatory
- This method must be implemented.