OSID - osid.cataloging.rules.CatalogEnablerSearchSession Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerSearchSession
Implements	`osid.cataloging.rules.CatalogEnablerQuerySession`
Description	This session provides methods for searching among `CatalogEnabler` objects. The search query is constructed using the `CatalogEnableryQuery.` `getCatalogEnablersByQuery()` is the basic search method and returns a list of `CatalogEnablers.` A more advanced search may be performed with `getCatalogEnablersBySearch().` It accepts a `CatalogEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCatalogEnablersBySearch()` returns a `CatalogEnablerSearchResults` that can be used to access the resulting `CatalogEnablerList` or be used to perform a search within the result set through `CatalogEnablerSearch.` This session defines views that offer differing behaviors for searching. federated catalog view: searches include catalog enablers in catalogs of which this catalog is an ancestor in the catalog hierarchy isolated catalog view: searches are restricted to catalog enablers in this catalog `CatalogEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `CatalogEnablerQuery.`
Method	getCatalogEnablerSearch
Description	Gets a catalog enabler search.
Return	`osid.cataloging.rules.CatalogEnablerSearch`		the catalog enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerSearchOrder
Description	Gets a catalog enabler search order. The `CatalogEnablerSearchOrder` is supplied to a `CatalogEnablerSearch` to specify the ordering of results.
Return	`osid.cataloging.rules.CatalogEnablerSearchOrder`		the catalog enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.cataloging.rules.CatalogEnablerQuery`	`catalogEnablerQuery`	the catalog enabler query
Parameters	`osid.cataloging.rules.CatalogEnablerSearch`	`catalogEnablerSearch`	the catalog enabler search
Return	`osid.cataloging.rules.CatalogEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`catalogEnablerQuery` or `catalogEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogEnablerQuery` or `catalogEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerQueryFromInspector
Description	Gets a catalog enabler query from an inspector. The inspector is available from a `CatalogEnablerSearchResults.`
Parameters	`osid.cataloging.rules.CatalogEnablerQueryInspector`	`catalogEnablerQueryInspector`	a catalog enabler query inspector
Return	`osid.cataloging.rules.CatalogEnablerQuery`		the catalog enabler query
Errors	NULL_ARGUMENT		`catalogEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`catalogEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.