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