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

Interface	osid.offering.rules.OfferingConstrainerSmartCatalogueSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogues. An `OfferingConstrainerQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of offering constrainers. The offering constrainer may be sequenced using the `OfferingConstrainerSearchOrder` from this session. This `Catalogue` has a default query that matches any offering constrainer and a default search order that specifies no sequencing. The queries may be examined using an `OfferingConstrainerQueryInspector`. The query may be modified by converting the inspector back to an `OfferingConstrainerQuery`.
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	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	getOfferingConstrainerQuery
Description	Gets an offering constrainer query.
Return	`osid.offering.rules.OfferingConstrainerQuery`		the offering constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerSearchOrder
Description	Gets an offering constrainer search order.
Return	`osid.offering.rules.OfferingConstrainerSearchOrder`		the offering constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingConstrainerQuery
Description	Applies an offering constrainer query to this catalogue.
Parameters	`osid.offering.rules.OfferingConstrainerQuery`	`offeringConstrainerQuery`	the offering constrainer query
Errors	NULL_ARGUMENT		`offeringConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOfferingConstrainerQuery
Description	Gets an offering constrainer query inspector for this catalogue.
Return	`osid.offering.rules.OfferingConstrainerQueryInspector`		the offering constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingConstrainerSequencing
Description	Applies an offering constrainer search order to this catalogue.
Parameters	`osid.offering.rules.OfferingConstrainerSearchOrder`	`offeringConstrainerSearchOrder`	the offering constrainer search order
Errors	NULL_ARGUMENT		`offeringConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerQueryFromInspector
Description	Gets an offering constrainer query from an inspector.
Parameters	`osid.offering.rules.OfferingConstrainerQueryInspector`	`offeringConstrainerQueryInspector`	an offering constrainer query inspector
Return	`osid.offering.rules.OfferingConstrainerQuery`		the offering constrainer query
Errors	NULL_ARGUMENT		`offeringConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`offeringConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.