OSID - osid.offering.OfferingQuerySession Service Interface Definition

Interface	osid.offering.OfferingQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for querying `Offering` objects. The search query is constructed using the `OfferingQuery.` This session defines views that offer differing behaviors for searching. federated catalogue view: searches include offerings in catalogues of which this catalogue is a ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to offerings in this catalogue Offerings may have a query record indicated by their respective record types. The query record is accessed via the `OfferingQuery.` 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	canSearchOfferings
Description	Tests if this user can perform `Offering` 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 offerings 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	getOfferingQuery
Description	Gets an offering query.
Return	`osid.offering.OfferingQuery`		the offering query
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByQuery
Description	Gets a list of offerings matching the given offering query.
Parameters	`osid.offering.OfferingQuery`	`offeringQuery`	the offering query
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`offeringQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.