org.osid.recognition

Interface AcademySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface AcademySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AcademySearchOrderRecord	getAcademySearchOrderRecord(Type academyRecordType) Gets the academy search order record corresponding to the given academy 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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getAcademySearchOrderRecord

AcademySearchOrderRecord getAcademySearchOrderRecord(Type academyRecordType)
                                                     throws OperationFailedException

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

Parameters:

academyRecordType - an academy record type

Returns:

the academy search order record

Throws:

NullArgumentException - academyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(academyRecordType) is false

Compliance:

mandatory - This method must be implemented.