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

This session provides methods for searching among CanonicalUnitEnabler objects. The search query is constructed using the CanonicalUnitEnablerQuery.

This session defines views that offer differing behaviors for searching.

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

CanonicalUnit constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the CanonicalUnitEnablerQuery.

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.
MethodcanSearchCanonicalUnitEnablers
Description

Tests if this user can perform CanonicalUnitEnabler lookups. 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 not offer lookup 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 unit enablers in catalogues which are children of this broker in the catalogue hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCatalogueView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetCanonicalUnitEnablerQuery
Description

Gets a canonical unit enabler query.

Returnosid.offering.rules.CanonicalUnitEnablerQuerythe canonical unit enabler query
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablersByQuery
Description

Gets a list of CanonicalUnitEnablers matching the given search.

Parametersosid.offering.rules.CanonicalUnitEnablerQuerycanonicalUnitEnablerQuerythe canonical unit constraienr enabler query
Returnosid.offering.rules.CanonicalUnitEnablerListthe returned CanonicalUnitEnablerList
ErrorsNULL_ARGUMENT canonicalUnitEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.