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

An Action executes a Scene, Setting, another ActionGroup, or other Rule . An Action is also an OsidRule that may or may not be active.

MethodgetActionGroupId
Description

Gets the action group Id for this action.

Returnosid.id.Idthe action group Id
CompliancemandatoryThis method must be implemented.
MethodgetActionGroup
Description

Gets the action group for this action.

Returnosid.control.ActionGroupthe action group
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDelay
Description

Gets the delay before proceeding with execution.

Returnosid.calendaring.Durationthe delay
CompliancemandatoryThis method must be implemented.
MethodisBlocking
Description

Tests if this action blocks further actions until complete.

Returnboolean true if blocking, false if subsequent actions can begin before this action completes
CompliancemandatoryThis method must be implemented.
MethodexecutesActionGroup
Description

Tests if this rule executes a scene. If executesActionGroup() is true, hasRule(), executesScene(), executesSetting(), and executesMatchingSetting() must be false.

Returnboolean true if this is a scene execution, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetNextActionGroupId
Description

Gets the action group Id to execute.

Returnosid.id.Idthe action group Id
ErrorsILLEGAL_STATE executesActionGroup() is false
CompliancemandatoryThis method must be implemented.
MethodgetNextActionGroup
Description

Gets the action group to execute,

Returnosid.control.ActionGroupthe action group
ErrorsILLEGAL_STATE executesActionGroup() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodexecutesScene
Description

Tests if this rule executes a scene. If executesScene() is true, hasRule(), executesActionGroup(), executesSetting(), and executesMatchingSetting() must be false.

Returnboolean true if this is a scene execution, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSceneId
Description

Gets the scene Id.

Returnosid.id.Idthe scene Id
ErrorsILLEGAL_STATE executesScene() is false
CompliancemandatoryThis method must be implemented.
MethodgetScene
Description

Gets the scene.

Returnosid.control.Scenethe scene
ErrorsILLEGAL_STATE executesScene() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodexecutesSetting
Description

Tests if this rule executes a setting. If executesSetting() is true, hasRule(), executesActionGroup(), executesScene(), and executesMatchingSetting() must be false.

Returnboolean true if this is a setting execution, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSettingId
Description

Gets the setting Id.

Returnosid.id.Idthe setting Id
ErrorsILLEGAL_STATE executesSetting() is false
CompliancemandatoryThis method must be implemented.
MethodgetSetting
Description

Gets the setting.

Returnosid.control.Settingthe setting
ErrorsILLEGAL_STATE executesSetting() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodexecutesMatchingSetting
Description

Tests if this rule executes a matching setting. If executesMatchingSetting() is true, hasRule(), executesScene(), executesActionGroup(), and executesSetting() must be false.

Returnboolean true if this is a setting execution, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMatchingControllerId
Description

Gets the matching controller Id.

Returnosid.id.Idthe controller Id
ErrorsILLEGAL_STATE executesMatchingSetting() is false
CompliancemandatoryThis method must be implemented.
MethodgetMatchingController
Description

Gets the matching controller.

Returnosid.control.Controllerthe controller
ErrorsILLEGAL_STATE executesMatchingSetting() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetMatchingAmountFactor
Description

Gets the factor by which the matching amount differs. A factor of 1 matches the amount of the matching controller.

Returndecimalthe factor
ErrorsILLEGAL_STATE executesMatchingSetting() is false
CompliancemandatoryThis method must be implemented.
MethodgetMatchingRateFactor
Description

Gets the factor by which the matching transition rate differs. A factor of 1 matches the ramp rate of the matching controller.

Returndecimalthe factor
ErrorsILLEGAL_STATE executesMatchingSetting() is false
CompliancemandatoryThis method must be implemented.
MethodgetActionRecord
Description

Gets the action record corresponding to the given Action record Type. This method is used to retrieve an object implementing the requested record. The actionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(actionRecordType) is true .

Parametersosid.type.TypeactionRecordTypethe type of action record to retrieve
Returnosid.control.records.ActionRecordthe action record
ErrorsNULL_ARGUMENT actionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(actionRecordType) is false
CompliancemandatoryThis method must be implemented.