Interface TextSearchOrder

All Superinterfaces:

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

public interface TextSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
TextSearchOrderRecord	getTextSearchOrderRecord(Type textRecordType)	Gets the text search order record corresponding to the given text record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

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

Method Details

getTextSearchOrderRecord

TextSearchOrderRecord getTextSearchOrderRecord(Type textRecordType)
                                        throws OperationFailedException

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

Parameters:

textRecordType - a text record type

Returns:

the text search order record

Throws:

NullArgumentException - textRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(textRecordType) is false

Compliance:

mandatory - This method must be implemented.