public interface Input extends OsidRelationship
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.).
Modifier and Type | Method and Description |
---|---|
Controller |
getController()
Gets the controller.
|
Id |
getControllerId()
Gets the controller
Id. |
Device |
getDevice()
Gets the device.
|
Id |
getDeviceId()
Gets the device
Id. |
InputRecord |
getInputRecord(Type inputRecordType)
Gets the input record corresponding to the given
Input
record Type. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getDeviceId()
Id.
Id
mandatory
- This method must be implemented. Device getDevice() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getControllerId()
Id.
Id
mandatory
- This method must be implemented. Controller getController() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. InputRecord getInputRecord(Type inputRecordType) throws OperationFailedException
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
.inputRecordType
- the type of input record to retrieveNullArgumentException
- inputRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inputRecordType)
is false
mandatory
- This method must be implemented.