org.osid.offering.rules

Interface CanonicalUnitEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface CanonicalUnitEnabler
extends OsidEnabler

A CanonicalUnitEnabler describes the rules for making an OfferingConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitEnablerRecord	getCanonicalUnitEnablerRecord(Type canonicalUnitEnablerRecordType) Gets the canonical unit enabler record corresponding to the given CanonicalUnitEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getCanonicalUnitEnablerRecord

CanonicalUnitEnablerRecord getCanonicalUnitEnablerRecord(Type canonicalUnitEnablerRecordType)
                                                         throws OperationFailedException

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 .

Parameters:

canonicalUnitEnablerRecordType - the type of canonical unit enabler record to retrieve

Returns:

the canonical unit enabler record

Throws:

NullArgumentException - canonicalUnitEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.