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

This session provides methods to retrieve CanonicalUnitEnabler to CanonicalUnit mappings. A CanonicalUnit with multiple CanonicalUnitEnablers means any positive rule evaluation across the enablers result in an effective CanonicalUnit.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated catalogue view: All methods in this session operate, retrieve and pertain canonical unit enablers defined explicitly in the current catalogue
  • federated catalogue view: All methods in this session operate, retrieve and pertain to all canonical unit enablers defined in this catalogue and any other canonical unit enablers implicitly available in this catalogue through catalogue inheritence.
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.
MethodcanLookupCanonicalUnitEnablerRules
Description

Tests if this user can perform lookups of canonical unit enabler/canonical unit mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCanonicalUnitEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCanonicalUnitEnablerRuleView
Description

A complete view of the CanonicalUnitEnabler and CanonicalUnit returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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 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 lookups to this catalogue only.

CompliancemandatoryThis method is must be implemented.
MethodgetCanonicalUnitEnablerIdsForCanonicalUnit
Description

Gets the CanonicalUnitEnabler Id associated with a CanonicalUnit.

Parametersosid.id.IdcanonicalUnitId Id of the CanonicalUnit
Returnosid.id.IdListthe canonical unit enabler Ids
ErrorsNOT_FOUND canonicalUnitId is not found
NULL_ARGUMENT canonicalUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablersForCanonicalUnit
Description

Gets the CanonicalUnitEnablers associated with a CanonicalUnit.

Parametersosid.id.IdcanonicalUnitId Id of the CanonicalUnit
Returnosid.offering.rules.CanonicalUnitEnablerListthe canonical unit enablers
ErrorsNOT_FOUND canonicalUnitId is not found
NULL_ARGUMENT canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitIdsForCanonicalUnitEnabler
Description

Gets the CanonicalUnit Ids mapped to a CanonicalUnitEnabler.

Parametersosid.id.IdcanonicalUnitEnablerId Id of a CanonicalUnitEnabler
Returnosid.id.IdListlist of canonical unit Ids
ErrorsNOT_FOUND canonicalUnitEnablerId is not found
NULL_ARGUMENT canonicalUnitEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitsForCanonicalUnitEnabler
Description

Gets the CanonicalUnits mapped to a CanonicalUnitEnabler.

Parametersosid.id.IdcanonicalUnitEnablerId Id of a CanonicalUnitEnabler
Returnosid.offering.CanonicalUnitListlist of canonical units
ErrorsNOT_FOUND canonicalUnitEnablerId is not found
NULL_ARGUMENT canonicalUnitEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.