Interface | osid.grading.GradebookSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getGradebooks | ||
Description |
Gets the gradebook list resulting from the search. | ||
Return | osid.grading.GradebookList | the gradebook list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.grading.GradebookQueryInspector | the gradebook query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookSearchResultsRecord | ||
Description |
Gets the gradebook search results record corresponding
to the given gradebook search record | ||
Parameters | osid.type.Type | gradebookSearchRecordType | a gradebook search record type |
Return | osid.grading.records.GradebookSearchResultsRecord | the gradebook search results 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. |