org.osid.calendaring.rules

Interface SupersedingEventEnabler

All Superinterfaces:

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

public interface SupersedingEventEnabler
extends OsidEnabler

A SupersedingEventEnabler describes the rules for making a SupersedingEvent effective.

Method Summary

Methods

Modifier and Type	Method and Description
SupersedingEventEnablerRecord	getSupersedingEventEnablerRecord(Type supersedingEventEnablerRecordType) Gets the superseding event enabler record corresponding to the given SupersedingEventEnabler 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

getSupersedingEventEnablerRecord

SupersedingEventEnablerRecord getSupersedingEventEnablerRecord(Type supersedingEventEnablerRecordType)
                                                               throws OperationFailedException

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

Parameters:

supersedingEventEnablerRecordType - the type of superseding event enabler record to retrieve

Returns:

the superseding event enabler record

Throws:

NullArgumentException - supersedingEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.