Interface ItemSearchOrder

All Superinterfaces:

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

public interface ItemSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
ItemSearchOrderRecord	getItemSearchOrderRecord(Type itemRecordType)	Gets the item search order record corresponding to the given item record Type .
QuestionSearchOrder	getQuestionSearchOrder()	Gets a question search order.
void	orderByQuestion(SearchOrderStyle style)	Specifies a preference for ordering the result set by the question.
boolean	supportsQuestionSearchOrder()	Tests if a question 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

orderByQuestion

void orderByQuestion(SearchOrderStyle style)

Specifies a preference for ordering the result set by the question.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsQuestionSearchOrder

boolean supportsQuestionSearchOrder()

Tests if a question search order is available.

Returns:

true if a question search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQuestionSearchOrder

QuestionSearchOrder getQuestionSearchOrder()

Gets a question search order.

Returns:

a question search order

Throws:

UnimplementedException - supportsQuestionSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsQuestionSearchOrder()} is {@code true} .

getItemSearchOrderRecord

ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType)
                                        throws OperationFailedException

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

Parameters:

itemRecordType - an item record type

Returns:

the item search order record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.