Interface CourseCatalogSearchOrder

All Superinterfaces:

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

public interface CourseCatalogSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CourseCatalogSearchOrderRecord	getCourseCatalogSearchOrderRecord(Type courseCatalogRecordType)	Gets the course catalog search order record corresponding to the given course record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

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

Methods inherited from interface OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Details

getCourseCatalogSearchOrderRecord

CourseCatalogSearchOrderRecord getCourseCatalogSearchOrderRecord(Type courseCatalogRecordType)
                                                          throws OperationFailedException

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

Parameters:

courseCatalogRecordType - a course catalog record type

Returns:

the course catalog search order record

Throws:

NullArgumentException - courseCatalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseCatalogRecordType) is false

Compliance:

mandatory - This method must be implemented.