Interface Setting

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface Setting extends OsidObject, Subjugateable

An Setting is a preset value for a Controller .

  • Method Details

    • 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.

    • isOn

      boolean isOn()
      Tests if the toggleable controller is on.
      Returns:
      true if the controller is on, false otherwise
      Throws:
      IllegalStateException - Controller.isToggleable() is false
      Compliance:
      mandatory - This method must be implemented.

    • isOff

      boolean isOff()
      Tests if the toggleable controller is off.
      Returns:
      true if the controller is iff, false otherwise
      Throws:
      IllegalStateException - Controller.isToggleable() is false
      Compliance:
      mandatory - This method must be implemented.

    • getVariableAmount

      BigDecimal getVariableAmount()
      Gets the level amount on a fixed scale.
      Returns:
      the level amount
      Throws:
      IllegalStateException - Controller.isVariable() is false
      Compliance:
      mandatory - This method must be implemented.

    • getDiscreetStateId

      Id getDiscreetStateId()
      Gets the discreet State Id .
      Returns:
      the state Id
      Throws:
      IllegalStateException - Controller.hasDiscreetStates() is false
      Compliance:
      mandatory - This method must be implemented.

    • getDiscreetState

      State getDiscreetState() throws OperationFailedException
      Gets the discreet State .
      Returns:
      the state
      Throws:
      IllegalStateException - Controller.hasDiscreetStates() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRampRate

      Duration getRampRate()
      Gets the ramp rate from off to on to use for the transition for this setting. If the ramp rate is 10 seconds and the variable percentage is 50%, then the actual transition duration from off would be 5 seconds for a linear controller.
      Returns:
      the ramp rate
      Throws:
      IllegalStateException - Controller.isRampable() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSettingRecord

      SettingRecord getSettingRecord(Type settingRecordType) throws OperationFailedException
      Gets the setting record corresponding to the given Setting record Type .This method is used to retrieve an object implementing the requested record. The settingRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(settingRecordType) is true .
      Parameters:
      settingRecordType - the type of setting record to retrieve
      Returns:
      the setting record
      Throws:
      NullArgumentException - settingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(settingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.