Interface | osid.grading.GradebookSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The interface for governing gradebook searches. | ||
Method | searchAmongGradebooks | ||
Description |
Execute this search among the given list of gradebooks. | ||
Parameters | osid.id.IdList | gradebookIds | list of gradebooks |
Errors | NULL_ARGUMENT | gradebookIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderGradebookResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.grading.GradebookSearchOrder | gradebookSearchOrder | gradebook search order |
Errors | NULL_ARGUMENT | gradebookSearchOrder is null | |
UNSUPPORTED | gradebookSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookSearchRecord | ||
Description |
Gets the gradebook search record corresponding to the
given gradebook search record | ||
Parameters | osid.type.Type | gradebookSearchRecordType | a gradebook search record type |
Return | osid.grading.records.GradebookSearchRecord | the gradebook search record | |
Errors | NULL_ARGUMENT | gradebookSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(gradebookSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |