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

Interface	osid.offering.rules.CanonicalUnitProcessorSmartCatalogueSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogues. A `CanonicalUnitProcessorQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of canonical unit processors. The canonical unit processor may be sequenced using the `CanonicalUnitProcessorSearchOrder` from this session. This `Catalogue` has a default query that matches any canonical unit processor and a default search order that specifies no sequencing. The queries may be examined using a `CanonicalUnitProcessorQueryInspector.` The query may be modified by converting the inspector back to a `CanonicalUnitProcessorQuery.`
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	getCanonicalUnitProcessorQuery
Description	Gets a canonical unit processor query.
Return	`osid.offering.rules.CanonicalUnitProcessorQuery`		the canonical unit processor query
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorSearchOrder
Description	Gets a canonical unit processor search order.
Return	`osid.offering.rules.CanonicalUnitProcessorSearchOrder`		the canonical unit processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitProcessorQuery
Description	Applies a canonical unit processor query to this catalogue.
Parameters	`osid.offering.rules.CanonicalUnitProcessorQuery`	`canonicalUnitProcessorQuery`	the canonical unit processor query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonicalUnitProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCanonicalUnitProcessorQuery
Description	Gets a canonical unit processor query inspector for this catalogue.
Return	`osid.offering.rules.CanonicalUnitProcessorQueryInspector`		the canonical unit processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitProcessorSequencing
Description	Applies a canonical unit processor search order to this catalogue.
Parameters	`osid.offering.rules.CanonicalUnitProcessorSearchOrder`	`canonicalUnitProcessorSearchOrder`	the canonical unit processor search order
Errors	NULL_ARGUMENT		`canonicalUnitProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonicalUnitProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitProcessorQueryFromInspector
Description	Gets a canonical unit processor query from an inspector.
Parameters	`osid.offering.rules.CanonicalUnitProcessorQueryInspector`	`canonicalUnitProcessorQueryInspector`	a canonical unit processor query inspector
Return	`osid.offering.rules.CanonicalUnitProcessorQuery`		the canonical unit processor query
Errors	NULL_ARGUMENT		`canonicalUnitProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.