OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
recognition package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recognition.AwardSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing award searches. | ||
| Method | searchAmongAwards | ||
| Description |
Execute this search among the given list of awards. | ||
| Parameters | osid.id.IdList | awardIds | list of awards |
| Errors | NULL_ARGUMENT | awardIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAwardResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.recognition.AwardSearchOrder | awardSearchOrder | award search order |
| Errors | NULL_ARGUMENT | awardSearchOrder is null | |
| UNSUPPORTED | awardSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardSearchRecord | ||
| Description |
Gets the award search record corresponding to the given
award search record | ||
| Parameters | osid.type.Type | awardSearchRecordType | an award search record type |
| Return | osid.recognition.records.AwardSearchRecord | the award search 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. | |