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

Interface	osid.offering.rules.CanonicalUnitProcessorEnablerSearchSession
Implements	`osid.offering.rules.CanonicalUnitProcessorEnablerQuerySession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session provides methods for searching among `CanonicalUnitProcessorEnabler` objects. The search query is constructed using the `CanonicalUnitProcessorEnableryQuery`. `getCanonicalUnitProcessorEnablersByQuery()` is the basic search method and returns a list of `CanonicalUnitProcessorEnablers`. A more advanced search may be performed with `getCanonicalUnitProcessorEnablersBySearch()`.It accepts a `CanonicalUnitProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getCanonicalUnitProcessorEnablersBySearch()` returns a `CanonicalUnitProcessorEnablerSearchResults` that can be used to access the resulting `CanonicalUnitProcessorEnablerList` or be used to perform a search within the result set through `CanonicalUnitProcessorEnablerSearch`. This session defines views that offer differing behaviors for searching. federated catalogue view: searches include canonical unit processor enablers in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to canonical unit processor enablers in this catalogue `CanonicalUnitProcessorEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `CanonicalUnitProcessorEnablerQuery`.
Method	getCanonicalUnitProcessorEnablerSearch
Description	Gets a canonical unit processor enabler search.
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerSearch`		the canonical unit processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerSearchOrder
Description	Gets a canonical unit processor enabler search order. The `CanonicalUnitProcessorEnablerSearchOrder` is supplied to a `CanonicalUnitProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerSearchOrder`		the canonical unit processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`	`canonicalUnitProcessorEnablerQuery`	the canonical unit processor enabler query
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerSearch`	`canonicalUnitProcessorEnablerSearch`	the canonical unit processor enabler search
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerQuery` or `canonicalUnitProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitProcessorEnablerQuery` or `canonicalUnitProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerQueryFromInspector
Description	Gets a canonical unit processor enabler query from an inspector. The inspector is available from a `CanonicalUnitProcessorEnablerSearchResults`.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerQueryInspector`	`canonicalUnitProcessorEnablerQueryInspector`	a canonical unit processor enabler query inspector
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`		the canonical unit processor enabler query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.