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

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

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.