Interface Input

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
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.).

  • Method Details

    • getDeviceId

      Id getDeviceId()
      Gets the device Id .
      Returns:
      the device Id
      Compliance:
      mandatory - This method must be implemented.

    • getDevice

      Device getDevice() throws OperationFailedException
      Gets the device.
      Returns:
      the device
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getControllerId

      Id getControllerId()
      Gets the controller Id .
      Returns:
      the controller Id
      Compliance:
      mandatory - This method must be implemented.

    • getController

      Controller getController() throws OperationFailedException
      Gets the controller.
      Returns:
      the controller
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInputRecord

      InputRecord getInputRecord(Type inputRecordType) throws OperationFailedException
      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 .
      Parameters:
      inputRecordType - the type of input record to retrieve
      Returns:
      the input record
      Throws:
      NullArgumentException - inputRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(inputRecordType) is false
      Compliance:
      mandatory - This method must be implemented.