org.osid.course

Interface CourseOfferingSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface CourseOfferingSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CourseOfferingSearchOrderRecord	getCourseOfferingSearchOrderRecord(Type courseOfferingRecordType) Gets the course offering search order record corresponding to the given course offering record Type.
CourseSearchOrder	getCourseSearchOrder() Gets the course order.
EventSearchOrder	getEventSearchOrder() Gets the event order.
TermSearchOrder	getTermSearchOrder() Gets the term order.
void	orderByCourse(SearchOrderStyle style) Specifies a preference for ordering the result set by course.
void	orderByEvent(SearchOrderStyle style) Specifies a preference for ordering the result set by event.
void	orderByMaximumSeats(SearchOrderStyle style) Specifies a preference for ordering the result set by the maximum seats.
void	orderByMinimumSeats(SearchOrderStyle style) Specifies a preference for ordering the result set by the minimum seats.
void	orderByNumber(SearchOrderStyle style) Specifies a preference for ordering the result set by course offering number.
void	orderByRequiresRegistration(SearchOrderStyle style) Specifies a preference for ordering the result set by course offerings requiring registration.
void	orderByScheduleInfo(SearchOrderStyle style) Specifies a preference for ordering the result set by schedule info.
void	orderByTerm(SearchOrderStyle style) Specifies a preference for ordering the result set by term.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by course offering title.
void	orderByURL(SearchOrderStyle style) Specifies a preference for ordering the result set by url.
boolean	supportsCourseSearchOrder() Tests if a course order is available.
boolean	supportsEventSearchOrder() Tests if an event search order is available.
boolean	supportsTermSearchOrder() Tests if a term order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByCourse

void orderByCourse(SearchOrderStyle style)

Specifies a preference for ordering the result set by course.

Parameters:

style - a 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.

orderByTerm

void orderByTerm(SearchOrderStyle style)

Specifies a preference for ordering the result set by term.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTermSearchOrder

boolean supportsTermSearchOrder()

Tests if a term order is available.

Returns:

true if a term order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets the term order.

Returns:

the term search order

Throws:

UnimplementedException - supportsTermSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsTermSearchOrder() is true.

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by course offering 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 offering number.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRequiresRegistration

void orderByRequiresRegistration(SearchOrderStyle style)

Specifies a preference for ordering the result set by course offerings requiring registration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMinimumSeats

void orderByMinimumSeats(SearchOrderStyle style)

Specifies a preference for ordering the result set by the minimum seats.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMaximumSeats

void orderByMaximumSeats(SearchOrderStyle style)

Specifies a preference for ordering the result set by the maximum seats.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByURL

void orderByURL(SearchOrderStyle style)

Specifies a preference for ordering the result set by url.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByScheduleInfo

void orderByScheduleInfo(SearchOrderStyle style)

Specifies a preference for ordering the result set by schedule info.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEvent

void orderByEvent(SearchOrderStyle style)

Specifies a preference for ordering the result set by event.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEventSearchOrder

boolean supportsEventSearchOrder()

Tests if an event search order is available.

Returns:

true if an event order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEventSearchOrder

EventSearchOrder getEventSearchOrder()

Gets the event order.

Returns:

the event search order

Throws:

UnimplementedException - supportsEventSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsEventSearchOrder() is true.

getCourseOfferingSearchOrderRecord

CourseOfferingSearchOrderRecord getCourseOfferingSearchOrderRecord(Type courseOfferingRecordType)
                                                                   throws OperationFailedException

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

Parameters:

courseOfferingRecordType - a course offering record type

Returns:

the course offering search order record

Throws:

NullArgumentException - courseOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.