OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitEnabler
Implementsosid.OsidEnabler
Description

A CanonicalUnitEnabler describes the rules for making an OfferingConstrainer effective.

MethodgetCanonicalUnitEnablerRecord
Description

Gets the canonical unit enabler record corresponding to the given CanonicalUnitEnabler record Type. This method is used to retrieve an object implementing the requested record. The canonicalUnitEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(canonicalUnitEnablerRecordType) is true .

Parametersosid.type.TypecanonicalUnitEnablerRecordTypethe type of canonical unit enabler record to retrieve
Returnosid.offering.rules.records.CanonicalUnitEnablerRecordthe canonical unit enabler record
ErrorsNULL_ARGUMENT canonicalUnitEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.