OSID - osid.offering.CatalogueSearchSession Service Interface Definition

Interface	osid.offering.CatalogueSearchSession
Implements	`osid.offering.CatalogueQuerySession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for searching `Catalogues` . The search query is constructed using the `CatalogueQuery` . The catalogue record `Type` also specifies the catalogue query record for the catalogue query. `getCataloguesByQuery()` is the basic search method and returns a list of `Catalogue` elements. A more advanced search may be performed with `getCataloguesBySearch()` . It accepts a `CatalogueSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCataloguesBySearch()` returns a `CatalogueSearchResults` that can be used to access the resulting `CatalogueList` or be used to perform a search within the result set through `CatalogueSearch` . Catalogues may have a query record indicated by their respective record types. The query record is accessed via the `CatalogueQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getCatalogueSearch
Description	Gets a catalogue search.
Return	`osid.offering.CatalogueSearch`		the catalogue search
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueSearchOrder
Description	Gets a catalogue search order. The `CatalogueSearchOrder` is supplied to a `CatalogueSearch` to specify the ordering of results.
Return	`osid.offering.CatalogueSearchOrder`		the catalogue search order
Compliance	`mandatory`		This method must be implemented.
Method	getCataloguesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.offering.CatalogueQuery`	`catalogueQuery`	the catalogue query
Parameters	`osid.offering.CatalogueSearch`	`catalogueSearch`	the catalogue search
Return	`osid.offering.CatalogueSearchResults`		the search results
Errors	NULL_ARGUMENT		`catalogueQuery` or `catalogueSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogueQuery` or `catalogueSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueQueryFromInspector
Description	Gets a catalogue query from an inspector. The inspector is available from a `CatalogueSearchResults` .
Parameters	`osid.offering.CatalogueQueryInspector`	`catalogueQueryInspector`	a catalogue query inspector
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	NULL_ARGUMENT		`catalogueQueryInspector` is `null`
Errors	UNSUPPORTED		`icatalogueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.