OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.OfferingSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing offering searches. | ||
| Method | searchAmongOfferings | ||
| Description |
Execute this search among the given list of offerings. | ||
| Parameters | osid.id.IdList | offeringIds | list of offerings |
| Errors | NULL_ARGUMENT | offeringIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOfferingResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.OfferingSearchOrder | offeringSearchOrder | offering search order |
| Errors | NULL_ARGUMENT | offeringSearchOrder is null | |
| UNSUPPORTED | offeringSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingSearchRecord | ||
| Description |
Gets the record corresponding to the given offering
search record | ||
| Parameters | osid.type.Type | offeringSearchRecordType | an offering search record type |
| Return | osid.offering.records.OfferingSearchRecord | the offering search record | |
| Errors | NULL_ARGUMENT | offeringSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offeringSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |