OSID - osid.offering.CanonicalUnitQuerySession Service Interface Definition

Interface	osid.offering.CanonicalUnitQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for querying `CanonicalUnit` objects. The search query is constructed using the `CanonicalUnitQuery.` This session defines views that offer differing behaviors for searching. federated catalogue view: searches include canonical units in catalogues of which this catalogue is a ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to canonical units in this catalogue Canonical units 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	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchCanonicalUnits
Description	Tests if this user can perform `CanonicalUnit` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include canonical units in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitQuery
Description	Gets a canonical unit query.
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitsByQuery
Description	Gets a list of canonical units matching the given canonical unit query.
Parameters	`osid.offering.CanonicalUnitQuery`	`canonicalUnitQuery`	the canonical unit query
Return	`osid.offering.CanonicalUnitList`		the returned `CanonicalUnitList`
Errors	NULL_ARGUMENT		`canonicalUnitQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.