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

Interface	osid.offering.rules.CanonicalUnitEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.offering.rules.CanonicalUnitEnablerSearchSession`
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 `CanonicalUnitEnablerQuery`. 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 CanonicalUnit constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `CanonicalUnitEnablerQuery`.
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	canSearchCanonicalUnitEnablers
Description	Tests if this user can perform `CanonicalUnitEnabler` lookups. 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 not offer lookup 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 unit enablers in catalogues which are children of this broker 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 lookups to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCanonicalUnitEnablerQuery
Description	Gets a canonical unit enabler query.
Return	`osid.offering.rules.CanonicalUnitEnablerQuery`		the canonical unit enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitEnablersByQuery
Description	Gets a list of `CanonicalUnitEnablers` matching the given search.
Parameters	`osid.offering.rules.CanonicalUnitEnablerQuery`	`canonicalUnitEnablerQuery`	the canonical unit constraienr enabler query
Return	`osid.offering.rules.CanonicalUnitEnablerList`		the returned `CanonicalUnitEnablerList`
Errors	NULL_ARGUMENT		`canonicalUnitEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`canonicalUnitEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.