Interface | osid.course.chronicle.AwardEntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAwardEntries | ||
Description |
Gets the course list resulting from a search. | ||
Return | osid.course.chronicle.AwardEntryList | the award entry list | |
Errors | ILLEGAL_STATE | the award entry list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.chronicle.AwardEntryQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntrySearchResultsRecord | ||
Description |
Gets the award entry search results record
corresponding to the given award entry search record
| ||
Parameters | osid.type.Type | awardEntrySearchRecordType | an award entry search record type |
Return | osid.course.chronicle.records.AwardEntrySearchResultsRecord | the award entry search results record | |
Errors | NULL_ARGUMENT | awardEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(awardEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |