OSID Logo
OSID Specifications
offering rules package
Version 3.1.0
Interfaceosid.offering.rules.CanonicalUnitEnabler
Implementsosid.OsidEnabler
Used Byosid.offering.rules.CanonicalUnitEnablerAdminSession
osid.offering.rules.CanonicalUnitEnablerList
osid.offering.rules.CanonicalUnitEnablerLookupSession
Description

A CanonicalUnitEnabler describes the rules for making an OfferingConstrainer effective.

Like all OsidObjects, CanonicalUnitEnabler is managed by its OsidSessions and may not be accessed by concurrent processing threads.

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.TypecanonicalUnitEnablerRecordType the type of canonical unit enabler record to retrieve
Returnosid.offering.rules.records.CanonicalUnitEnablerRecord the canonical unit enabler record
ErrorsNULL_ARGUMENT canonicalUnitEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(canonicalUnitEnablerRecordType) is false
Compliancemandatory This method must be implemented.