Interface | osid.offering.OfferingSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getOfferings | ||
Description |
Gets the offering list resulting from a search. | ||
Return | osid.offering.OfferingList | the offering list | |
Errors | ILLEGAL_STATE | the list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.offering.OfferingQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingSearchResultsRecord | ||
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.OfferingSearchResultsRecord | the offering search results 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. |