OSID - osid.offering.rules.CanonicalUnitEnablerSearchSession Service Interface Definition

Interface	osid.offering.rules.CanonicalUnitEnablerSearchSession
Implements	`osid.offering.rules.CanonicalUnitEnablerQuerySession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session provides methods for searching among `CanonicalUnitEnabler` objects. The search query is constructed using the `CanonicalUnitEnableryQuery`. `getCanonicalUnitEnablersByQuery()` is the basic search method and returns a list of `CanonicalUnitEnablers`. A more advanced search may be performed with `getCanonicalUnitEnablersBySearch()`. It accepts a `CanonicalUnitEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getCanonicalUnitEnablersBySearch()` returns a `CanonicalUnitEnablerSearchResults` that can be used to access the resulting `CanonicalUnitEnablerList` or be used to perform a search within the result set through `CanonicalUnitEnablerSearch`. This session defines views that offer differing behaviors for searching. federated catalogue view: searches include canonical unit enablers in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to canonical unit enablers in this catalogue `CanonicalUnitEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `CanonicalUnitEnablerQuery`.
Method	getCanonicalUnitEnablerSearch
Description	Gets a canonical unit enabler search.
Return	`osid.offering.rules.CanonicalUnitEnablerSearch`		the canonical unit enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablerSearchOrder
Description	Gets a canonical unit enabler search order. The `CanonicalUnitEnablerSearchOrder` is supplied to a `CanonicalUnitEnablerSearch` to specify the ordering of results.
Return	`osid.offering.rules.CanonicalUnitEnablerSearchOrder`		the canonical unit enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.offering.rules.CanonicalUnitEnablerQuery`	`canonicalUnitEnablerQuery`	the canonical unit enabler query
Parameters	`osid.offering.rules.CanonicalUnitEnablerSearch`	`canonicalUnitEnablerSearch`	the canonical unit enabler search
Return	`osid.offering.rules.CanonicalUnitEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`canonicalUnitEnablerQuery` or `canonicalUnitEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitEnablerQuery` or `canonicalUnitEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablerQueryFromInspector
Description	Gets a canonical unit enabler query from an inspector. The inspector is available from a `CanonicalUnitEnablerSearchResults`.
Parameters	`osid.offering.rules.CanonicalUnitEnablerQueryInspector`	`canonicalUnitEnablerQueryInspector`	a canonical unit enabler query inspector
Return	`osid.offering.rules.CanonicalUnitEnablerQuery`		the canonical unit enabler query
Errors	NULL_ARGUMENT		`canonicalUnitEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.