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

Interface	osid.offering.rules.OfferingConstrainerEnablerSmartCatalogueSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogues. An `OfferingConstrainerEnablerQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of offering constrainer enablers. The offering constrainer enablers may be sequenced using the `OfferingConstrainerEnablerSearchOrder` from this session. This `Catalogue` has a default query that matches any offering constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using an `OfferingConstrainerEnablerQueryInspector.` The query may be modified by converting the inspector back to an `OfferingConstrainerEnablerQuery.`
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	getOfferingConstrainerEnablerQuery
Description	Gets an offering constrainer enabler query.
Return	`osid.offering.rules.OfferingConstrainerEnablerQuery`		the offering constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerEnablerSearchOrder
Description	Gets an offering constrainer enabler search order.
Return	`osid.offering.rules.OfferingConstrainerEnablerSearchOrder`		the offering constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingConstrainerEnablerQuery
Description	Applies an offering constrainer enabler query to this catalogue.
Parameters	`osid.offering.rules.OfferingConstrainerEnablerQuery`	`offeringConstrainerEnablerQuery`	the offering constrainer enabler query
Errors	NULL_ARGUMENT		`offeringConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringConstrainerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOfferingConstrainerEnablerQuery
Description	Gets an offering constrainer enabler query inspector for this catalogue.
Return	`osid.offering.rules.OfferingConstrainerEnablerQueryInspector`		the offering constrainer enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOfferingConstrainerEnablerSequencing
Description	Applies an offering constrainer enabler search order to this catalogue.
Parameters	`osid.offering.rules.OfferingConstrainerEnablerSearchOrder`	`offeringConstrainerEnablerSearchOrder`	the offering constrainer enabler search order
Errors	NULL_ARGUMENT		`offeringConstrainerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`offeringConstrainerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerEnablerQueryFromInspector
Description	Gets an offering constrainer enabler query from an inspector.
Parameters	`osid.offering.rules.OfferingConstrainerEnablerQueryInspector`	`offeringConstrainerEnablerQueryInspector`	an offering constrainer enabler query inspector
Return	`osid.offering.rules.OfferingConstrainerEnablerQuery`		the offering constrainer enabler query
Errors	NULL_ARGUMENT		`offeringConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`offeringConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.