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

Interface	osid.offering.rules.CanonicalUnitProcessorSearchSession
Implements	`osid.offering.rules.CanonicalUnitProcessorQuerySession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session provides methods for searching among `CanonicalUnitProcessor` objects. The search query is constructed using the `CanonicalUnitProcessoryQuery`. `getCanonicalUnitProcessorsByQuery()` is the basic search method and returns a list of `CanonicalUnitProcessors`. A more advanced search may be performed with `getCanonicalUnitProcessorsBySearch()`.It accepts a `CanonicalUnitProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getCanonicalUnitProcessorsBySearch()` returns a `CanonicalUnitProcessorSearchResults` that can be used to access the resulting `CanonicalUnitProcessorList` or be used to perform a search within the result set through `CanonicalUnitProcessorSearch`. This session defines views that offer differing behaviors for searching. federated catalogue view: searches include canonical unit processor in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to canonical unit processor in this catalogue `CanonicalUnitProcessors` may have a query record indicated by their respective record types. The query record is accessed via the `CanonicalUnitProcessorQuery`.
Method	getCanonicalUnitProcessorSearch
Description	Gets a canonical unit processor search.
Return	`osid.offering.rules.CanonicalUnitProcessorSearch`		the canonical unit processor search
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorSearchOrder
Description	Gets a canonical unit processor search order. The `CanonicalUnitProcessorSearchOrder` is supplied to a `CanonicalUnitProcessorSearch` to specify the ordering of results.
Return	`osid.offering.rules.CanonicalUnitProcessorSearchOrder`		the canonical unit processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.offering.rules.CanonicalUnitProcessorQuery`	`canonicalUnitProcessorQuery`	the canonical unit processor query
Parameters	`osid.offering.rules.CanonicalUnitProcessorSearch`	`canonicalUnitProcessorSearch`	the canonical unit processor search
Return	`osid.offering.rules.CanonicalUnitProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`canonicalUnitProcessorQuery` or `canonicalUnitProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitProcessorQuery` or `canonicalUnitProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorQueryFromInspector
Description	Gets a canonical unit processor query from an inspector. The inspector is available from a `CanonicalUnitProcessorSearchResults`.
Parameters	`osid.offering.rules.CanonicalUnitProcessorQueryInspector`	`canonicalUnitProcessorQueryInspector`	a canonical unit processor query inspector
Return	`osid.offering.rules.CanonicalUnitProcessorQuery`		the canonical unit processor query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.