| Interface | osid.grading.GradeSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.grading.GradeSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getGrades | ||
| Description |
Gets the grade list resulting from a search. | ||
| Return | osid.grading.GradeList | the grade list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.grading.GradeQueryInspector | the grade query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeSearchResultsRecord | ||
| Description |
Gets the grade search results record corresponding to
the given grade search record | ||
| Parameters | osid.type.Type | gradeSearchRecordType | a grade search record type |
| Return | osid.grading.records.GradeSearchResultsRecord | the grade search results record | |
| Errors | NULL_ARGUMENT | gradeSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(gradeSearchRecordTypee) is false | ||
| Compliance | mandatory | This method must be implemented. | |