org.osid.course

Interface TermSearchOrder

All Superinterfaces:

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

public interface TermSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
TermSearchOrderRecord	getTermSearchOrderRecord(Type termRecordType) Gets the term search order record corresponding to the given course record Type.
void	orderByAddDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the add date.
void	orderByClassesDuration(SearchOrderStyle style) Specifies a preference for ordering the result set by the duration of the classes period.
void	orderByClassesEnd(SearchOrderStyle style) Specified a preference for ordering results by classes end.
void	orderByClassesStart(SearchOrderStyle style) Specified a preference for ordering results by classes start.
void	orderByCloseDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the close date.
void	orderByDisplayLabel(SearchOrderStyle style) Specifies a preference for ordering the result set by course title.
void	orderByDropDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the drop date.
void	orderByFinalExamDuration(SearchOrderStyle style) Specifies a preference for ordering the result set by the duration of the final exam period.
void	orderByFinalExamEnd(SearchOrderStyle style) Specified a preference for ordering results by final exam end.
void	orderByFinalExamStart(SearchOrderStyle style) Specified a preference for ordering results by final exam start.
void	orderByOpenDate(SearchOrderStyle style) Specified a preference for ordering results by the open date.
void	orderByRegistrationDuration(SearchOrderStyle style) Specifies a preference for ordering the result set by the duration of the registration period.
void	orderByRegistrationEnd(SearchOrderStyle style) Specified a preference for ordering results by registration end.
void	orderByRegistrationStart(SearchOrderStyle style) Specified a preference for ordering results by registration start.

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

orderByDisplayLabel

void orderByDisplayLabel(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.

orderByOpenDate

void orderByOpenDate(SearchOrderStyle style)

Specified a preference for ordering results by the open date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRegistrationStart

void orderByRegistrationStart(SearchOrderStyle style)

Specified a preference for ordering results by registration start.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRegistrationEnd

void orderByRegistrationEnd(SearchOrderStyle style)

Specified a preference for ordering results by registration end.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRegistrationDuration

void orderByRegistrationDuration(SearchOrderStyle style)

Specifies a preference for ordering the result set by the duration of the registration period.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByClassesStart

void orderByClassesStart(SearchOrderStyle style)

Specified a preference for ordering results by classes start.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByClassesEnd

void orderByClassesEnd(SearchOrderStyle style)

Specified a preference for ordering results by classes end.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByClassesDuration

void orderByClassesDuration(SearchOrderStyle style)

Specifies a preference for ordering the result set by the duration of the classes period.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAddDate

void orderByAddDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the add date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDropDate

void orderByDropDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the drop date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFinalExamStart

void orderByFinalExamStart(SearchOrderStyle style)

Specified a preference for ordering results by final exam start.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFinalExamEnd

void orderByFinalExamEnd(SearchOrderStyle style)

Specified a preference for ordering results by final exam end.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFinalExamDuration

void orderByFinalExamDuration(SearchOrderStyle style)

Specifies a preference for ordering the result set by the duration of the final exam period.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCloseDate

void orderByCloseDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the close date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getTermSearchOrderRecord

TermSearchOrderRecord getTermSearchOrderRecord(Type termRecordType)
                                               throws OperationFailedException

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

Parameters:

termRecordType - a term record type

Returns:

the term search order record

Throws:

NullArgumentException - termRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(termRecordType) is false

Compliance:

mandatory - This method must be implemented.