public interface CanonicalUnitEnabler extends OsidEnabler
A CanonicalUnitEnabler
describes the rules for making an
OfferingConstrainer
effective.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitEnablerRecord |
getCanonicalUnitEnablerRecord(Type canonicalUnitEnablerRecordType)
Gets the canonical unit enabler record corresponding to the given
CanonicalUnitEnabler record Type. |
getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getEndDate, getStartDate, isEffective
CanonicalUnitEnablerRecord getCanonicalUnitEnablerRecord(Type canonicalUnitEnablerRecordType) throws OperationFailedException
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
.canonicalUnitEnablerRecordType
- the type of canonical unit
enabler record to retrieveNullArgumentException
-
canonicalUnitEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitEnablerRecordType)
is
false
mandatory
- This method must be implemented.