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