OSID - osid.offering.OfferingSearchSession Service Interface Definition

Interface	osid.offering.OfferingSearchSession
Implements	`osid.offering.OfferingQuerySession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for searching `Offerings` . The search query is constructed using the `OfferingQuery` . The offering record `Type` also specifies the record for the offering query. `getOfferingsByQuery()` is the basic search method and returns a list of `Offering` elements. A more advanced search may be performed with `getOfferingsBySearch()` .It accepts an `OfferingSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOfferingsBySearch()` returns an `OfferingSearchResults` that can be used to access the resulting `OfferingList` or be used to perform a search within the result set through `OfferingSearch` . This session defines views that offer differing behaviors for searching. federated catalogue view: searches include offerings in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to offerings in this catalogue Offerings may have a query record indicated by their respective record types. The query record is accessed via the `OfferingQuery` . The returns in this session may not be cast directly to these interfaces.
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 `OfferingSearchOrder` is supplied to an `OfferingSearch` to specify the ordering of results.
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
Parameters	`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 `OfferingSearchResults` .
Parameters	`osid.offering.OfferingQueryInspector`	`offeringQueryInspector`	an offering query inspector
Return	`osid.offering.OfferingQuery`		the offering query
Errors	NULL_ARGUMENT		`offeringQueryInspector` is `null`
Errors	UNSUPPORTED		`offeringQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.