OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitSmartCatalogueSession
Implementsosid.OsidSession
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.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe Catalogue associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartCatalogues
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.

Returnboolean false if smart catalogue management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitQuery
Description

Gets a canonical unit query.

Returnosid.offering.CanonicalUnitQuerythe canonical unit query
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitSearchOrder
Description

Gets a canonical unit search order.

Returnosid.offering.CanonicalUnitSearchOrderthe canonical unit search order
CompliancemandatoryThis method must be implemented.
MethodapplyCanonicalUnitQuery
Description

Applies a canonical unit query to this catalogue.

Parametersosid.offering.CanonicalUnitQuerycanonicalUnitQuerythe canonical unit query
ErrorsNULL_ARGUMENT canonicalUnitQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED canonical unitQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCanonicalUnitQuery
Description

Gets a canonical unit query inspector for this catalogue.

Returnosid.offering.CanonicalUnitQueryInspectorthe canonical unit query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCanonicalUnitSequencing
Description

Applies a canonical unit search order to this catalogue.

Parametersosid.offering.CanonicalUnitSearchOrdercanonicalUnitSearchOrderthe canonical unit search order
ErrorsNULL_ARGUMENT canonicalUnitSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED canonicalUnitSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitQueryFromInspector
Description

Gets a canonical unit query from an inspector.

Parametersosid.offering.CanonicalUnitQueryInspectorcanonicalUnitQueryInspectora query inspector
Returnosid.offering.CanonicalUnitQuerythe canonical unit query
ErrorsNULL_ARGUMENT canonicalUnitQueryInspector is null
UNSUPPORTED canonicalUnitQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.