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