org.osid.calendaring.rules

Interface RecurringEventEnabler

All Superinterfaces:

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

public interface RecurringEventEnabler
extends OsidEnabler

A RecurringEventEnabler describes the rules for making a RecurringEvent effective.

Method Summary

Methods

Modifier and Type	Method and Description
RecurringEventEnablerRecord	getRecurringEventEnablerRecord(Type recurringEventEnablerRecordType) Gets the recurring event enabler record corresponding to the given RecurringEventEnabler 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

getRecurringEventEnablerRecord

RecurringEventEnablerRecord getRecurringEventEnablerRecord(Type recurringEventEnablerRecordType)
                                                           throws OperationFailedException

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

Parameters:

recurringEventEnablerRecordType - the type of recurring event enabler record to retrieve

Returns:

the recurring event enabler record

Throws:

NullArgumentException - recurringEventEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.