org.osid.control

Interface Device

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Device
extends OsidObject

A Device manages a set of Inputs to Controllers.

Method Summary

Methods

Modifier and Type	Method and Description
DeviceRecord	getDeviceRecord(Type deviceRecordType) Gets the device record corresponding to the given Device record Type.

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

Method Detail

getDeviceRecord

DeviceRecord getDeviceRecord(Type deviceRecordType)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

deviceRecordType - the type of device record to retrieve

Returns:

the device record

Throws:

NullArgumentException - deviceRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(deviceRecordType) is false

Compliance:

mandatory - This method must be implemented.