org.osid.dictionary

Interface DictionarySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface DictionarySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DictionarySearchOrderRecord	getDictionarySearchOrderRecord(Type dictionaryRecordType) Gets the dictionary search order record corresponding to the given dictionary 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.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getDictionarySearchOrderRecord

DictionarySearchOrderRecord getDictionarySearchOrderRecord(Type dictionaryRecordType)
                                                           throws OperationFailedException

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

Parameters:

dictionaryRecordType - a dictionary record type

Returns:

the dictionary search order record

Throws:

NullArgumentException - dictionaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionaryRecordType) is false

Compliance:

mandatory - This method must be implemented.