public interface GradebookColumnSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
GradebookColumnSearchOrderRecord |
getGradebookColumnSearchOrderRecord(Type gradebookColumnRecordType)
Gets the gradebook column search order record corresponding to the
given gradebook column record
Type. |
GradeSystemSearchOrder |
getGradebookColumnSummarySearchOrder()
Gets the search order for a grade system.
|
GradebookColumnSummarySearchOrder |
getGradeSystemSearchOrder()
Gets the search order for a gradebook column summary search order.
|
void |
orderByGradeSystem(SearchOrderStyle style)
Specified a preference for ordering results by the grade system.
|
boolean |
supportsGradebookColumnSummarySearchOrder()
Tests if a
GradebookColumnSummarySearchOrder is
available for gradebook column summaries. |
boolean |
supportsGradeSystemSearchOrder()
Tests if a
GradeSystemSearchOrder 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
is available for
grade systems. true
if a grade system search order is
available, false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getGradebookColumnSummarySearchOrder()
UnimplementedException
-
supportsGradeSystemSearchOrder()
is false
optional
- This method must be implemented if
supportsGradeSystemSearchOrder()
is true.
boolean supportsGradebookColumnSummarySearchOrder()
GradebookColumnSummarySearchOrder
is
available for gradebook column summaries. true
if a gradebook column summary search order
is available, false
otherwisemandatory
- This method must be implemented. GradebookColumnSummarySearchOrder getGradeSystemSearchOrder()
UnimplementedException
-
supportsGradebookColumnSummarySearchOrder()
is
false
optional
- This method must be implemented if
supportsGradebookColumnSummarySearchOrder()
is
true.
GradebookColumnSearchOrderRecord getGradebookColumnSearchOrderRecord(Type gradebookColumnRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.gradebookColumnRecordType
- a gradebook column record typeNullArgumentException
-
gradebookColumnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookColumnRecordType)
is
false
mandatory
- This method must be implemented.