OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.Input
Implementsosid.OsidRelationship
Used Byosid.control.InputAdminSession
osid.control.InputList
osid.control.InputLookupSession
Description

An Input is an OsidRelationship between a Device and a Controller. A Controller is the point of control or execution in a system while the Device is the presentation. For example, a joystick device has controllers for the stick and the firing buttons. The firing button controllers may also appear on a keyboard device. The Input describes how to interact with the Controller (photon torpedo) on the device (push button, press spacebar, etc.).

MethodgetDeviceId
Description

Gets the device Id.

Returnosid.id.Id the device Id
Compliancemandatory This method must be implemented.
MethodgetDevice
Description

Gets the device.

Returnosid.control.Device the device
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetControllerId
Description

Gets the controller Id.

Returnosid.id.Id the controller Id
Compliancemandatory This method must be implemented.
MethodgetController
Description

Gets the controller.

Returnosid.control.Controller the controller
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetInputRecord
Description

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

Parametersosid.type.TypeinputRecordType the type of input record to retrieve
Returnosid.control.records.InputRecord the input record
ErrorsNULL_ARGUMENT inputRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inputRecordType) is false
Compliancemandatory This method must be implemented.