public interface GradeSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
GradeSearchOrderRecord |
getGradeSearchOrderRecord(Type gradeRecordType)
Gets the grade search order record corresponding to the given grade
record
Type. |
GradeSystemSearchOrder |
getGradeSystemSearchOrder()
Gets the search order for a grade system.
|
void |
orderByGradeSystem(SearchOrderStyle style)
Specified a preference for ordering results by the grade system.
|
void |
orderByInputScoreEndRange(SearchOrderStyle style)
Specified a preference for ordering results by end of the input score
range.
|
void |
orderByInputScoreStartRange(SearchOrderStyle style)
Specified a preference for ordering results by start of the input
score range.
|
void |
orderByOutputScore(SearchOrderStyle style)
Specified a preference for ordering results by the output score.
|
boolean |
supportsGradeSystemSearchOrder()
Tests if a
GradeSystemSearchOrder interface is
available for grade systems. |
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByGradeSystem(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradeSystemSearchOrder()
GradeSystemSearchOrder
interface is
available for grade systems. true
if a grade system search order is
available, false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getGradeSystemSearchOrder()
UnimplementedException
-
supportsGradeSystemSearchOrder()
is false
optional
- This method must be implemented if
supportsGradeSystemSearchOrder()
is true.
void orderByInputScoreStartRange(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByInputScoreEndRange(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOutputScore(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. GradeSearchOrderRecord getGradeSearchOrderRecord(Type gradeRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.gradeRecordType
- a grade record typeNullArgumentException
- gradeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradeRecordType)
is false
mandatory
- This method must be implemented.