OSID - osid.offering.OfferingSmartCatalogueSession Service Interface Definition

Interface	osid.offering.OfferingSmartCatalogueSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `OfferingQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of `Offerings`. The offerings may be sequenced using the `OfferingSearchOrder` from this session. This `Catalogue` has a default query that matches any offering and a default search order that specifies no sequencing. The queries may be examined using an `OfferingQueryInspector`. The query may be modified by converting the inspector back to a n `OfferingQuery`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartCatalogues
Description	Tests if this user can manage smart catalogues. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart catalogue management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getOfferingSearchOrder
Description	Gets an offering search order.
Return	`osid.offering.OfferingSearchOrder`		the offering search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingQuery
Description	Applies an offering query to this catalogue.
Parameters	`osid.offering.OfferingQuery`	`offeringQuery`	the offering query
Errors	NULL_ARGUMENT		`offeringQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOfferingQuery
Description	Gets an offering query inspector for this catalogue.
Return	`osid.offering.OfferingQueryInspector`		the offering query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingSequencing
Description	Applies an offering search order to this catalogue.
Parameters	`osid.offering.OfferingSearchOrder`	`offeringSearchOrder`	the offering search order
Errors	NULL_ARGUMENT		`offeringSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingQueryFromInspector
Description	Gets an offering query from an inspector.
Parameters	`osid.offering.OfferingQueryInspector`	`offeringQueryInspector`	a query inspector
Return	`osid.offering.OfferingQuery`		the offering query
Errors	NULL_ARGUMENT		`offeringQueryInspector` is `null`
Errors	UNSUPPORTED		`offeringQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.