OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.ResultSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing result searches. | ||
| Method | searchAmongResults | ||
| Description |
Execute this search among the given list of results. | ||
| Parameters | osid.id.IdList | resultIds | list of results |
| Errors | NULL_ARGUMENT | resultIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderResultResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.ResultSearchOrder | resultSearchOrder | result search order |
| Errors | NULL_ARGUMENT | resultSearchOrder is null | |
| UNSUPPORTED | resultSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultSearchRecord | ||
| Description |
Gets the record corresponding to the given result
search record | ||
| Parameters | osid.type.Type | resultSearchRecordType | an result search record type |
| Return | osid.offering.records.ResultSearchRecord | the result search record | |
| Errors | NULL_ARGUMENT | resultSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(resultSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |