Interface SyllabusSearchOrder

All Superinterfaces:

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

public interface SyllabusSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CourseSearchOrder	getCourseSearchOrder()	Gets the course order.
SyllabusSearchOrderRecord	getSyllabusSearchOrderRecord(Type syllabusRecordType)	Gets the syllabus search order record corresponding to the given syllabus record Type .
void	orderByCourse(SearchOrderStyle style)	Specifies a preference for ordering the result set by the course.
boolean	supportsCourseSearchOrder()	Tests if a course order is available.

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 .

Method Details

orderByCourse

void orderByCourse(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseSearchOrder

boolean supportsCourseSearchOrder()

Tests if a course order is available.

Returns:

true if a course order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrder

CourseSearchOrder getCourseSearchOrder()

Gets the course order.

Returns:

the course search order

Throws:

UnimplementedException - supportsCourseSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSearchOrder()} is {@code true} .

getSyllabusSearchOrderRecord

SyllabusSearchOrderRecord getSyllabusSearchOrderRecord(Type syllabusRecordType)
                                                throws OperationFailedException

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

Parameters:

syllabusRecordType - a syllabus record type

Returns:

the syllabus search order record

Throws:

NullArgumentException - syllabusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusRecordType) is false

Compliance:

mandatory - This method must be implemented.