public interface CourseEntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CourseEntrySearchOrderRecord |
getCourseEntrySearchOrderRecord(Type courseEntryRecordType)
Gets the course entry search order record corresponding to the given
course entry entry record
Type. |
CourseSearchOrder |
getCourseSearchOrder()
Gets the course order.
|
GradeSystemSearchOrder |
getCreditScaleSearchOrder()
Gets the grade system search order.
|
GradeSearchOrder |
getGradeSearchOrder()
Gets the grade system search order.
|
GradeSystemSearchOrder |
getScoreScaleSearchOrder()
Gets the grade system order.
|
ResourceSearchOrder |
getStudentSearchOrder()
Gets the resource order.
|
TermSearchOrder |
getTermSearchOrder()
Gets the term order.
|
void |
orderByComplete(SearchOrderStyle style)
Specifies a preference for ordering the result set by completed
courses.
|
void |
orderByCourse(SearchOrderStyle style)
Specifies a preference for ordering the result set by the course.
|
void |
orderByCreditScale(SearchOrderStyle style)
Specifies a preference for ordering the result set by the grade system
for credits.
|
void |
orderByCreditsEarned(SearchOrderStyle style)
Specifies a preference for ordering the result set by the earned
credits.
|
void |
orderByGrade(SearchOrderStyle style)
Specifies a preference for ordering the result set by the grade.
|
void |
orderByScore(SearchOrderStyle style)
Specifies a preference for ordering the result set by the score.
|
void |
orderByScoreScale(SearchOrderStyle style)
Specifies a preference for ordering the result set by the grade system
for scores.
|
void |
orderByStudent(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
void |
orderByTerm(SearchOrderStyle style)
Specifies a preference for ordering the result set by the term.
|
boolean |
supportsCourseSearchOrder()
Tests if a course order is available.
|
boolean |
supportsCreditScaleSearchOrder()
Tests if a grade system order is available.
|
boolean |
supportsGradeSearchOrder()
Tests if a grade search order is available.
|
boolean |
supportsScoreScaleSearchOrder()
Tests if a grade system order is available.
|
boolean |
supportsStudentSearchOrder()
Tests if a resource order is available.
|
boolean |
supportsTermSearchOrder()
Tests if a term order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByStudent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStudentSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getStudentSearchOrder()
UnimplementedException
-
supportsStudentSearchOrder()
is false
optional
- This method must be implemented if
supportsStudentSearchOrder()
is true.
void orderByCourse(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCourseSearchOrder()
true
if a course order is available,
false
otherwisemandatory
- This method must be implemented. CourseSearchOrder getCourseSearchOrder()
UnimplementedException
-
supportsCourseSearchOrder()
is false
optional
- This method must be implemented if
supportsCourseSearchOrder()
is true.
void orderByTerm(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTermSearchOrder()
true
if a term order is available, false
otherwisemandatory
- This method must be implemented. TermSearchOrder getTermSearchOrder()
UnimplementedException
-
supportsTermSearchOrder()
is false
optional
- This method must be implemented if
supportsTermSearchOrder()
is true.
void orderByComplete(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCreditScale(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCreditScaleSearchOrder()
true
if a grade system 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 orderByCreditsEarned(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGrade(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradeSearchOrder()
true
if a grade order is available,
false
otherwisemandatory
- This method must be implemented. GradeSearchOrder getGradeSearchOrder()
UnimplementedException
-
supportsGradeSearchOrder()
is false
optional
- This method must be implemented if
supportsGradeSearchOrder()
is true.
void orderByScoreScale(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsScoreScaleSearchOrder()
true
if a grade system order is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getScoreScaleSearchOrder()
UnimplementedException
-
supportsScoreScaleSearchOrder()
is false
optional
- This method must be implemented if
supportsScoreScaleSearchOrder()
is true.
void orderByScore(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. CourseEntrySearchOrderRecord getCourseEntrySearchOrderRecord(Type courseEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.courseEntryRecordType
- a course entry record typeNullArgumentException
- courseEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseEntryRecordType)
is false
mandatory
- This method must be implemented.