org.osid.topology.rules

Interface EdgeEnabler

All Superinterfaces:

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

public interface EdgeEnabler
extends OsidEnabler

An EdgeEnabler describes the rules for making an Edge effective.

Method Summary

Methods

Modifier and Type	Method and Description
EdgeEnablerRecord	getEdgeEnablerRecord(Type edgeEnablerRecordType) Gets the edge enabler record corresponding to the given EdgeEnabler 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

getEdgeEnablerRecord

EdgeEnablerRecord getEdgeEnablerRecord(Type edgeEnablerRecordType)
                                       throws OperationFailedException

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

Parameters:

edgeEnablerRecordType - the type of edge enabler record to retrieve

Returns:

the edge enabler record

Throws:

NullArgumentException - edgeEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.