Interface IdiomSearchOrder

All Superinterfaces:

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

public interface IdiomSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
IdiomSearchOrderRecord	getIdiomSearchOrderRecord(Type idiomRecordType)	Gets the idiom search order record corresponding to the given idiom record Type .
TextSearchOrder	getTextSearchOrder()	Gets the text search order.
void	orderByFormatType(SearchOrderStyle style)	Orders the results by format type.
void	orderByLanguageType(SearchOrderStyle style)	Orders the results by language type.
void	orderByScriptType(SearchOrderStyle style)	Orders the results by script type.
void	orderByString(SearchOrderStyle style)	Orders the results by string.
void	orderByText(SearchOrderStyle style)	Orders the results by text.
boolean	supportsTextSearchOrder()	Tests if a text search order is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

orderByText

void orderByText(SearchOrderStyle style)

Orders the results by text.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTextSearchOrder

boolean supportsTextSearchOrder()

Tests if a text search order is available.

Returns:

true if a text search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTextSearchOrder

TextSearchOrder getTextSearchOrder()

Gets the text search order.

Returns:

the text search order

Throws:

IllegalStateException - supportsTextSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByLanguageType

void orderByLanguageType(SearchOrderStyle style)

Orders the results by language type.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByScriptType

void orderByScriptType(SearchOrderStyle style)

Orders the results by script type.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFormatType

void orderByFormatType(SearchOrderStyle style)

Orders the results by format type.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByString

void orderByString(SearchOrderStyle style)

Orders the results by string.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getIdiomSearchOrderRecord

IdiomSearchOrderRecord getIdiomSearchOrderRecord(Type idiomRecordType)
                                          throws OperationFailedException

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

Parameters:

idiomRecordType - an idiom record type

Returns:

the idiom search order record

Throws:

NullArgumentException - idiomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomRecordType) is false

Compliance:

mandatory - This method must be implemented.