OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitQuerySession
Implementsosid.OsidSession
Description

This session provides methods for querying CanonicalUnit objects. The search query is constructed using the CanonicalUnitQuery.

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include canonical units in catalogues of which this catalogue is a ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to canonical units in this catalogue

Canonical units may have a query record indicated by their respective record types. The query record is accessed via the CanonicalUnitQuery. The returns in this session may not be cast directly to these interfaces.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchCanonicalUnits
Description

Tests if this user can perform CanonicalUnit searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCatalogueView
Description

Federates the view for methods in this session. A federated view will include canonical units in catalogues which are children of this catalogue in the catalogue hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCatalogueView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this catalogue only.

CompliancemandatoryThis method is must be implemented.
MethodgetCanonicalUnitQuery
Description

Gets a canonical unit query.

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

Gets a list of canonical units matching the given canonical unit query.

Parametersosid.offering.CanonicalUnitQuerycanonicalUnitQuerythe canonical unit query
Returnosid.offering.CanonicalUnitListthe returned CanonicalUnitList
ErrorsNULL_ARGUMENT canonicalUnitQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitQuery is not of this service
CompliancemandatoryThis method must be implemented.