Interface | osid.offering.OfferingSearchSession | ||
---|---|---|---|
Implements | osid.offering.OfferingQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Offerings may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getOfferingSearch | ||
Description |
Gets an offering search. | ||
Return | osid.offering.OfferingSearch | the offering search | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingSearchOrder | ||
Description |
Gets an offering search order. The | ||
Return | osid.offering.OfferingSearchOrder | the offering search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.offering.OfferingQuery | offeringQuery | the offering query |
osid.offering.OfferingSearch | offeringSearch | the offering search | |
Return | osid.offering.OfferingSearchResults | the search results | |
Errors | NULL_ARGUMENT | offeringQuery or offeringSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | offeringQuery or offeringSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingQueryFromInspector | ||
Description |
Gets an offering query from an inspector. The inspector
is available from an | ||
Parameters | osid.offering.OfferingQueryInspector | offeringQueryInspector | an offering query inspector |
Return | osid.offering.OfferingQuery | the offering query | |
Errors | NULL_ARGUMENT | offeringQueryInspector is null | |
UNSUPPORTED | offeringQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |