org.osid.sequencing

Interface Chain

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Chain
extends OsidObject

An Chain is a chain resource. A chain is inactive if the input is disabled.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

isFifo

boolean isFifo()

Tests if elements are appended to the end of the chain.

Returns:

true if elements are appended to the end of the chain, false if elements are added to the top of the chain

Compliance:

mandatory - This method must be implemented.

getChainRecord

ChainRecord getChainRecord(Type chainRecordType)
                           throws OperationFailedException

Gets the chain record corresponding to the given 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 .

Parameters:

chainRecordType - the type of chain record to retrieve

Returns:

the chain record

Throws:

NullArgumentException - chainRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainRecordType) is false

Compliance:

mandatory - This method must be implemented.