OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.Input
Implementsosid.OsidRelationship
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.Idthe device Id
CompliancemandatoryThis method must be implemented.
MethodgetDevice
Description

Gets the device.

Returnosid.control.Devicethe device
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetControllerId
Description

Gets the controller Id.

Returnosid.id.Idthe controller Id
CompliancemandatoryThis method must be implemented.
MethodgetController
Description

Gets the controller.

Returnosid.control.Controllerthe controller
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.TypeinputRecordTypethe type of input record to retrieve
Returnosid.control.records.InputRecordthe input record
ErrorsNULL_ARGUMENT inputRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputRecordType) is false
CompliancemandatoryThis method must be implemented.