public interface TermSearchOrder extends OsidObjectSearchOrder, OsidFederateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByDisplayLabel(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOpenDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRegistrationStart(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRegistrationEnd(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRegistrationDuration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByClassesStart(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByClassesEnd(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByClassesDuration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAddDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDropDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByFinalExamStart(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByFinalExamEnd(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByFinalExamDuration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCloseDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. TermSearchOrderRecord getTermSearchOrderRecord(Type termRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.termRecordType
- a term record typeNullArgumentException
- termRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(termRecordType)
is false
mandatory
- This method must be implemented.