org.osid.recognition

Interface AwardSearchOrder

All Superinterfaces:

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

public interface AwardSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AwardSearchOrderRecord	getAwardSearchOrderRecord(Type awardRecordType) Gets the award search order record corresponding to the given award 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

Method Detail

getAwardSearchOrderRecord

AwardSearchOrderRecord getAwardSearchOrderRecord(Type awardRecordType)
                                                 throws OperationFailedException

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

Parameters:

awardRecordType - an award record type

Returns:

the award search order record

Throws:

NullArgumentException - awardRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardRecordType) is false

Compliance:

mandatory - This method must be implemented.