org.osid.contact.rules

Interface ContactEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface ContactEnabler
extends OsidEnabler

A ContactEnabler describes the rules for making Contacts effective.

Method Summary

Methods

Modifier and Type	Method and Description
ContactEnablerRecord	getContactEnablerRecord(Type contactEnablerRecordType) Gets the contact enabler record corresponding to the given ContactEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getContactEnablerRecord

ContactEnablerRecord getContactEnablerRecord(Type contactEnablerRecordType)
                                             throws OperationFailedException

Gets the contact enabler record corresponding to the given 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 .

Parameters:

contactEnablerRecordType - the type of contact enabler record to retrieve

Returns:

the contact enabler record

Throws:

NullArgumentException - contactEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.