org.osid.mapping.path.rules

Interface SignalEnabler

All Superinterfaces:

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

public interface SignalEnabler
extends OsidEnabler

A SignalEnabler describes the rules for enabling signals.

Method Summary

Methods

Modifier and Type	Method and Description
SignalEnablerRecord	getSignalEnablerRecord(Type signalEnablerRecordType) Gets the signal enabler record corresponding to the given SignalEnabler 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

getSignalEnablerRecord

SignalEnablerRecord getSignalEnablerRecord(Type signalEnablerRecordType)
                                           throws OperationFailedException

Gets the signal enabler record corresponding to the given SignalEnabler record Type. This method is used to retrieve an object implementing the requested record. The signalEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(signalEnablerRecordType) is true .

Parameters:

signalEnablerRecordType - the type of signal enabler record to retrieve

Returns:

the signal enabler record

Throws:

NullArgumentException - signalEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.