OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.Setting
Implementsosid.OsidObject
osid.Subjugateable
Description

An Setting is a preset value for a Controller.

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.
MethodisOn
Description

Tests if the toggleable controller is on.

Returnboolean true if the controller is on, false otherwise
ErrorsILLEGAL_STATE Controller.isToggleable() is false
CompliancemandatoryThis method must be implemented.
MethodisOff
Description

Tests if the toggleable controller is off.

Returnboolean true if the controller is iff, false otherwise
ErrorsILLEGAL_STATE Controller.isToggleable() is false
CompliancemandatoryThis method must be implemented.
MethodgetVariableAmount
Description

Gets the level amount on a fixed scale.

Returndecimalthe level amount
ErrorsILLEGAL_STATE Controller.isVariable() is false
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetStateId
Description

Gets the discreet State Id.

Returnosid.id.Idthe state Id
ErrorsILLEGAL_STATE Controller.hasDiscreetStates() is false
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetState
Description

Gets the discreet State.

Returnosid.process.Statethe state
ErrorsILLEGAL_STATE Controller.hasDiscreetStates() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRampRate
Description

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.

Returnosid.calendaring.Durationthe ramp rate
ErrorsILLEGAL_STATE Controller.isRampable() is false
CompliancemandatoryThis method must be implemented.
MethodgetSettingRecord
Description

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 .

Parametersosid.type.TypesettingRecordTypethe type of setting record to retrieve
Returnosid.control.records.SettingRecordthe setting record
ErrorsNULL_ARGUMENT settingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(settingRecordType) is false
CompliancemandatoryThis method must be implemented.