OSID - osid.offering.CanonicalUnitSmartCatalogueSession Service Interface Definition

Interface	osid.offering.CanonicalUnitSmartCatalogueSession
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. A `CanonicalUnitQuery` can be retrieved from this session and mapped to this `Catalogue` to create a virtual collection of `CanonicalUnits`. The canonical units may be sequenced using the `CanonicalUnitSearchOrder` from this session. This `Catalogue` has a default query that matches any canonical unit and a default search order that specifies no sequencing. The queries may be examined using a `CanonicalUnitQueryInspector`. The query may be modified by converting the inspector back to a `CanonicalUnitQuery`.
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	getCanonicalUnitQuery
Description	Gets a canonical unit query.
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitSearchOrder
Description	Gets a canonical unit search order.
Return	`osid.offering.CanonicalUnitSearchOrder`		the canonical unit search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitQuery
Description	Applies a canonical unit query to this catalogue.
Parameters	`osid.offering.CanonicalUnitQuery`	`canonicalUnitQuery`	the canonical unit query
Errors	NULL_ARGUMENT		`canonicalUnitQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonical unitQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCanonicalUnitQuery
Description	Gets a canonical unit query inspector for this catalogue.
Return	`osid.offering.CanonicalUnitQueryInspector`		the canonical unit query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCanonicalUnitSequencing
Description	Applies a canonical unit search order to this catalogue.
Parameters	`osid.offering.CanonicalUnitSearchOrder`	`canonicalUnitSearchOrder`	the canonical unit search order
Errors	NULL_ARGUMENT		`canonicalUnitSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`canonicalUnitSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitQueryFromInspector
Description	Gets a canonical unit query from an inspector.
Parameters	`osid.offering.CanonicalUnitQueryInspector`	`canonicalUnitQueryInspector`	a query inspector
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Errors	NULL_ARGUMENT		`canonicalUnitQueryInspector` is `null`
Errors	UNSUPPORTED		`canonicalUnitQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.