org.osid.assessment

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

Methods

Modifier and Type	Method and 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 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

Method Detail

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 supportsQuestionSearchOrder() is 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.