org.osid.calendaring.rules

Interface OffsetEventEnabler

All Superinterfaces:

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

public interface OffsetEventEnabler
extends OsidEnabler

An OffsetEventEnabler describes the rules for making an OffsetEvent effective.

Method Summary

Methods

Modifier and Type	Method and Description
OffsetEventEnablerRecord	getOffsetEventEnablerRecord(Type offsetEventEnablerRecordType) Gets the offset event enabler record corresponding to the given OffsetEventEnabler 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

getOffsetEventEnablerRecord

OffsetEventEnablerRecord getOffsetEventEnablerRecord(Type offsetEventEnablerRecordType)
                                                     throws OperationFailedException

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

Parameters:

offsetEventEnablerRecordType - the type of offset event enabler record to retrieve

Returns:

the offset event enabler record

Throws:

NullArgumentException - offsetEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.