public interface CourseSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CourseSearchOrderRecord |
getCourseSearchOrderRecord(Type courseRecordType)
Gets the course search order record corresponding to the given course
record
Type. |
GradeSystemSearchOrder |
getCreditScaleSearchOrder()
Specifies a preference for ordering the result set by the credit
scale.
|
void |
orderByCreditScale(SearchOrderStyle style)
Specifies a preference for ordering the result set by the credit
scale.
|
void |
orderByNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by course number.
|
void |
orderByPrerequisitesInfo(SearchOrderStyle style)
Specifies a preference for ordering the result set by course
prerequisite information.
|
void |
orderByTitle(SearchOrderStyle style)
Specifies a preference for ordering the result set by course title.
|
boolean |
supportsCreditScaleSearchOrder()
Tests if a grade system search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByTitle(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCreditScale(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCreditScaleSearchOrder()
true
if a grade system search order is
available, false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getCreditScaleSearchOrder()
UnimplementedException
-
supportsCreditScaleSearchOrder()
is false
optional
- This method must be implemented if
supportsCreditScaleSearchOrder()
is true.
void orderByPrerequisitesInfo(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. CourseSearchOrderRecord getCourseSearchOrderRecord(Type courseRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.courseRecordType
- a course record typeNullArgumentException
- courseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseRecordType)
is false
mandatory
- This method must be implemented.