org.osid.course.syllabus

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

Methods

Modifier and Type	Method and 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 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

Method Detail

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 supportsCourseSearchOrder() is 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.