Interface CourseSearchOrder

All Superinterfaces:

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

public interface CourseSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CourseSearchOrderRecord	getCourseSearchOrderRecord(Type courseRecordType)	Gets the course search order record corresponding to the given course record Type.
void	orderByNumber(SearchOrderStyle style)	Specifies a preference for ordering the result set by course number.
void	orderByPrerequisitesInfo(SearchOrderStyle style)	Specifies a preference for ordering the result set by course prerequisite information.
void	orderByTitle(SearchOrderStyle style)	Specifies a preference for ordering the result set by course title.

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 OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Details

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by course title.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByNumber

void orderByNumber(SearchOrderStyle style)

Specifies a preference for ordering the result set by course number.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPrerequisitesInfo

void orderByPrerequisitesInfo(SearchOrderStyle style)

Specifies a preference for ordering the result set by course prerequisite information.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrderRecord

CourseSearchOrderRecord getCourseSearchOrderRecord(Type courseRecordType)
                                            throws OperationFailedException

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

Parameters:

courseRecordType - a course record type

Returns:

the course search order record

Throws:

NullArgumentException - courseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRecordType) is false

Compliance:

mandatory - This method must be implemented.