org.osid.subscription

Interface DispatchSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface DispatchSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DispatchSearchOrderRecord	getDispatchSearchOrderRecord(Type dispatchRecordType) Gets the dispatch search order record corresponding to the given dispatch record Type.

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

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getDispatchSearchOrderRecord

DispatchSearchOrderRecord getDispatchSearchOrderRecord(Type dispatchRecordType)
                                                       throws OperationFailedException

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

Parameters:

dispatchRecordType - a dispatch record type

Returns:

the dispatch search order record

Throws:

NullArgumentException - dispatchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchRecordType) is false

Compliance:

mandatory - This method must be implemented.