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

Interface	osid.offering.rules.CanonicalUnitProcessorEnablerSmartCatalogueSession
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. A `CanonicalUnitProcessorEnablerQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of canonical unit processor enablers. The canonical unit processor enablers may be sequenced using the `CanonicalUnitProcessorEnablerSearchOrder` from this session. This `Catalogue` has a default query that matches any canonical unit processor enabler and a default search order that specifies no sequencing. The queries may be examined using a `CanonicalUnitProcessorEnablerQueryInspector`. The query may be modified by converting the inspector back to a `CanonicalUnitProcessorEnablerQuery`.
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	getCanonicalUnitProcessorEnablerQuery
Description	Gets a canonical unit processor enabler query.
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`		the canonical unit processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerSearchOrder
Description	Gets a canonical unit processor enabler search order.
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerSearchOrder`		the canonical unit processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitProcessorEnablerQuery
Description	Applies a canonical unit processor enabler query to this catalogue.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`	`canonicalUnitProcessorEnablerQuery`	the canonical unit processor enabler query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonicalUnitProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCanonicalUnitProcessorEnablerQuery
Description	Gets a canonical unit processor enabler query inspector for this catalogue.
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerQueryInspector`		the canonical unit processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitProcessorEnablerSequencing
Description	Applies a canonical unit processor enabler search order to this catalogue.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerSearchOrder`	`canonicalUnitProcessorEnablerSearchOrder`	the canonical unit processor enabler search order
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonicalUnitProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorEnablerQueryFromInspector
Description	Gets a canonical unit processor enabler query from an inspector.
Parameters	`osid.offering.rules.CanonicalUnitProcessorEnablerQueryInspector`	`canonicalUnitProcessorEnablerQueryInspector`	a canonical unit processor enabler query inspector
Return	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`		the canonical unit processor enabler query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.