OSID - osid.offering.CanonicalUnitSearchSession Service Interface Definition

Interface	osid.offering.CanonicalUnitSearchSession
Implements	`osid.offering.CanonicalUnitQuerySession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for searching `CanonicalUnits` . The search query is constructed using the `CanonicalUnitQuery` . The canonical unit record `Type` also specifies the record for the canonical unit query. `getCanonicalUnitsByQuery()` is the basic search method and returns a list of `CanonicalUnit` elements. A more advanced search may be performed with `getCanonicalUnitsBySearch()` . It accepts a `CanonicalUnitSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCanonicalUnitsBySearch()` returns a `CanonicalUnitSearchResults` that can be used to access the resulting `CanonicalUnitList` or be used to perform a search within the result set through `CanonicalUnitSearch` . This session defines views that offer differing behaviors for searching. federated catalogue view: searches include canonical units in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to canonical units in this catalogue CanonicalUnits may have a query record indicated by their respective record types. The query record is accessed via the `CanonicalUnitQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getCanonicalUnitSearch
Description	Gets a canonical unit search.
Return	`osid.offering.CanonicalUnitSearch`		the canonical unit search
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitSearchOrder
Description	Gets a canonical unit search order. The `CanonicalUnitSearchOrder` is supplied to a `CanonicalUnitSearch` to specify the ordering of results.
Return	`osid.offering.CanonicalUnitSearchOrder`		the canonical unit search order
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.offering.CanonicalUnitQuery`	`canonicalUnitQuery`	the canonical unit query
Parameters	`osid.offering.CanonicalUnitSearch`	`canonicalUnitSearch`	the canonical unit search
Return	`osid.offering.CanonicalUnitSearchResults`		the search results
Errors	NULL_ARGUMENT		`canonicalUnitQuery` or `canonicalUnitSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitQuery` or `canonicalUnitSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitQueryFromInspector
Description	Gets a canonical unit query from an inspector. The inspector is available from a `CanonicalUnitSearchResults` .
Parameters	`osid.offering.CanonicalUnitQueryInspector`	`canonicalUnitQueryInspector`	a canonical unit query inspector
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Errors	NULL_ARGUMENT		`canonicalUnitQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.