org.osid.resourcing.rules

Interface AvailabilityEnabler

All Superinterfaces:

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

public interface AvailabilityEnabler
extends OsidEnabler

A AvailabilityEnabler describes the rules for managing the effectiveness of an Availability.

Method Summary

Methods

Modifier and Type	Method and Description
AvailabilityEnablerRecord	getAvailabilityEnablerRecord(Type availabilityEnablerRecordType) Gets the availability enabler record corresponding to the given AvailabilityEnabler 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

getAvailabilityEnablerRecord

AvailabilityEnablerRecord getAvailabilityEnablerRecord(Type availabilityEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

availabilityEnablerRecordType - the type of availability enabler record to retrieve

Returns:

the availability enabler record

Throws:

NullArgumentException - availabilityEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(availabilityEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.