OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
recognition package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recognition.AwardSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAwards | ||
| Description |
Gets the award list resulting from a search. | ||
| Return | osid.recognition.AwardList | the award list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.recognition.AwardQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardSearchResultsRecord | ||
| Description |
Gets the award search results record corresponding to the given award search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | awardSearchRecordType | an award search record type |
| Return | osid.recognition.records.AwardSearchResultsRecord | the award search results record | |
| Errors | NULL_ARGUMENT | AwardSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(awardSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |