org.osid.control.rules

Interface DeviceEnabler

All Superinterfaces:

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

public interface DeviceEnabler
extends OsidEnabler

A DeviceEnabler describes the rules for making an Trigger effective.

Method Summary

Methods

Modifier and Type	Method and Description
DeviceEnablerRecord	getDeviceEnablerRecord(Type deviceEnablerRecordType) Gets the device enabler record corresponding to the given DeviceEnabler 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

getDeviceEnablerRecord

DeviceEnablerRecord getDeviceEnablerRecord(Type deviceEnablerRecordType)
                                           throws OperationFailedException

Gets the device enabler record corresponding to the given DeviceEnabler 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:

deviceEnablerRecordType - the type of device enabler record to retrieve

Returns:

the device enabler record

Throws:

NullArgumentException - deviceEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deviceEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.