public interface CompositionEnabler extends OsidEnabler
A CompositionEnabler
describes the rules for making
Compositions
visible in the composition hierarchy.
Modifier and Type | Method and Description |
---|---|
CompositionEnablerRecord |
getCompositionEnablerRecord(Type compositionEnablerRecordType)
Gets the composition enabler record corresponding to the given
CompositionEnabler 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
CompositionEnablerRecord getCompositionEnablerRecord(Type compositionEnablerRecordType) throws OperationFailedException
CompositionEnabler
record Type.
This method is
used to retrieve an object implementing the requested record. The
compositionEnablerRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(compositionEnablerRecordType)
is true
.compositionEnablerRecordType
- the type of composition enabler
record to retrieveNullArgumentException
-
compositionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionEnablerRecordType)
is
false
mandatory
- This method must be implemented.