org.osid.sequencing

Interface ChainSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface ChainSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ChainSearchOrderRecord	getChainSearchOrderRecord(Type chainRecordType) Gets the chain search order record corresponding to the given chain record Type.
void	orderByFifo(SearchOrderStyle style) Orders the results by the fifo flag.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderByFifo

void orderByFifo(SearchOrderStyle style)

Orders the results by the fifo flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getChainSearchOrderRecord

ChainSearchOrderRecord getChainSearchOrderRecord(Type chainRecordType)
                                                 throws OperationFailedException

Gets the chain search order record corresponding to the given chain record Type. Multiple retrievals return the same underlying object.

Parameters:

chainRecordType - a chain record type

Returns:

the chain search order record

Throws:

NullArgumentException - chainRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainRecordType) is false

Compliance:

mandatory - This method must be implemented.