org.osid.mapping.path.rules

Interface ObstacleEnabler

All Superinterfaces:

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

public interface ObstacleEnabler
extends OsidEnabler

An ObstacleEnabler describes the rules for enabling an obstacle.

Method Summary

Methods

Modifier and Type	Method and Description
ObstacleEnablerRecord	getObstacleEnablerRecord(Type obstacleEnablerRecordType) Gets the obstacle enabler record corresponding to the given ObstacleEnabler 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

getObstacleEnablerRecord

ObstacleEnablerRecord getObstacleEnablerRecord(Type obstacleEnablerRecordType)
                                               throws OperationFailedException

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

Parameters:

obstacleEnablerRecordType - the type of obstacle enabler record to retrieve

Returns:

the obstacle enabler record

Throws:

NullArgumentException - obstacleEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.