org.osid.control.rules

Interface InputEnabler

All Superinterfaces:

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

public interface InputEnabler
extends OsidEnabler

A InputEnabler describes the rules for making a Input effective.

Method Summary

Methods

Modifier and Type	Method and Description
InputEnablerRecord	getInputEnablerRecord(Type inputEnablerRecordType) Gets the input enabler record corresponding to the given InputEnabler 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

getInputEnablerRecord

InputEnablerRecord getInputEnablerRecord(Type inputEnablerRecordType)
                                         throws OperationFailedException

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

Parameters:

inputEnablerRecordType - the type of input enabler record to retrieve

Returns:

the input enabler record

Throws:

NullArgumentException - inputEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.