public interface Setting extends OsidObject, Subjugateable
An Setting
is a preset value for a Controller.
Modifier and Type | Method and Description |
---|---|
Controller |
getController()
Gets the controller.
|
Id |
getControllerId()
Gets the controller
Id. |
State |
getDiscreetState()
Gets the discreet
State. |
Id |
getDiscreetStateId()
Gets the discreet
State Id. |
Duration |
getRampRate()
Gets the ramp rate from off to on to use for the transition for this
setting.
|
SettingRecord |
getSettingRecord(Type settingRecordType)
Gets the setting record corresponding to the given
Setting
record Type. |
java.math.BigDecimal |
getVariableAmount()
Gets the level amount on a fixed scale.
|
boolean |
isOff()
Tests if the toggleable controller is off.
|
boolean |
isOn()
Tests if the toggleable controller is on.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getControllerId()
Id.
Id
mandatory
- This method must be implemented. Controller getController() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isOn()
true
if the controller is on, false
otherwiseIllegalStateException
-
Controller.isToggleable()
is false
mandatory
- This method must be implemented. boolean isOff()
true
if the controller is iff, false
otherwiseIllegalStateException
-
Controller.isToggleable()
is false
mandatory
- This method must be implemented. java.math.BigDecimal getVariableAmount()
IllegalStateException
- Controller.isVariable()
is false
mandatory
- This method must be implemented. Id getDiscreetStateId()
State
Id.
Id
IllegalStateException
-
Controller.hasDiscreetStates()
is false
mandatory
- This method must be implemented. State getDiscreetState() throws OperationFailedException
State.
IllegalStateException
-
Controller.hasDiscreetStates()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getRampRate()
IllegalStateException
- Controller.isRampable()
is false
mandatory
- This method must be implemented. SettingRecord getSettingRecord(Type settingRecordType) throws OperationFailedException
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
.settingRecordType
- the type of setting record to retrieveNullArgumentException
- settingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(settingRecordType)
is false
mandatory
- This method must be implemented.