OSID - osid.cataloging.CatalogSearchSession Service Interface Definition

Interface	osid.cataloging.CatalogSearchSession
Implements	`osid.cataloging.CatalogQuerySession`
Used By	`osid.cataloging.CatalogingManager`
Used By	`osid.cataloging.CatalogingProxyManager`
Description	This session provides methods for searching `Catalogs`. The search query is constructed using the `CatalogQuery`. The catalog record `Type` also specifies the record for the catalog query. `getCatalogsByQuery()` is the basic search method and returns a list of `Catalog` elements. A more advanced search may be performed with `getCatalogsBySearch()`.It accepts a `CatalogSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCatalogsBySearch()` returns a `CatalogSearchResults` that can be used to access the resulting `CatalogList` or be used to perform a search within the result set through `CatalogSearch`. Catalogs may have a query record indicated by their respective record types. The query record is accessed via the `CatalogQuery`.
Method	getCatalogSearch
Description	Gets a catalog search.
Return	`osid.cataloging.CatalogSearch`		the catalog search
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogSearchOrder
Description	Gets a subject search order. The `CatalogSearchOrder` is supplied to a `CatalogSearch` to specify the ordering of results.
Return	`osid.cataloging.CatalogSearchOrder`		the catalog search order
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.cataloging.CatalogQuery`	`catalogQuery`	the catalog query
Parameters	`osid.cataloging.CatalogSearch`	`catalogSearch`	the catalog search
Return	`osid.cataloging.CatalogSearchResults`		the search results
Errors	NULL_ARGUMENT		`catalogQuery` or `catalogSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogQuery` or `catalogSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogQueryFromInspector
Description	Gets a catalog query from an inspector. The inspector is available from an `CatalogSearchResults`.
Parameters	`osid.cataloging.CatalogQueryInspector`	`catalogQueryInspector`	a catalog query inspector
Return	`osid.cataloging.CatalogQuery`		the catalog query
Errors	NULL_ARGUMENT		`catalogQueryInspector` is `null`
Errors	UNSUPPORTED		`catalogQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.