Interface | osid.control.Action | ||
---|---|---|---|
Implements | osid.OsidRule | ||
osid.Subjugateable | |||
Description |
An | ||
Method | getActionGroupId | ||
Description |
Gets the action group | ||
Return | osid.id.Id | the action group Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroup | ||
Description |
Gets the action group for this action. | ||
Return | osid.control.ActionGroup | the action group | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getDelay | ||
Description |
Gets the delay before proceeding with execution. | ||
Return | osid.calendaring.Duration | the delay | |
Compliance | mandatory | This method must be implemented. | |
Method | isBlocking | ||
Description |
Tests if this action blocks further actions until complete. | ||
Return | boolean | true if blocking, false if subsequent actions
can begin before this action completes | |
Compliance | mandatory | This method must be implemented. | |
Method | executesActionGroup | ||
Description |
Tests if this rule executes a scene. If | ||
Return | boolean | true if this is a scene execution, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getNextActionGroupId | ||
Description |
Gets the action group | ||
Return | osid.id.Id | the action group Id | |
Errors | ILLEGAL_STATE | executesActionGroup() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getNextActionGroup | ||
Description |
Gets the action group to execute, | ||
Return | osid.control.ActionGroup | the action group | |
Errors | ILLEGAL_STATE | executesActionGroup() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | executesScene | ||
Description |
Tests if this rule executes a scene. If | ||
Return | boolean | true if this is a scene execution, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneId | ||
Description |
Gets the scene | ||
Return | osid.id.Id | the scene Id | |
Errors | ILLEGAL_STATE | executesScene() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getScene | ||
Description |
Gets the scene. | ||
Return | osid.control.Scene | the scene | |
Errors | ILLEGAL_STATE | executesScene() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | executesSetting | ||
Description |
Tests if this rule executes a setting. If | ||
Return | boolean | true if this is a setting execution, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingId | ||
Description |
Gets the setting | ||
Return | osid.id.Id | the setting Id | |
Errors | ILLEGAL_STATE | executesSetting() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSetting | ||
Description |
Gets the setting. | ||
Return | osid.control.Setting | the setting | |
Errors | ILLEGAL_STATE | executesSetting() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | executesMatchingSetting | ||
Description |
Tests if this rule executes a matching setting. If
| ||
Return | boolean | true if this is a setting execution, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMatchingControllerId | ||
Description |
Gets the matching controller | ||
Return | osid.id.Id | the controller Id | |
Errors | ILLEGAL_STATE | executesMatchingSetting() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getMatchingController | ||
Description |
Gets the matching controller. | ||
Return | osid.control.Controller | the controller | |
Errors | ILLEGAL_STATE | executesMatchingSetting() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMatchingAmountFactor | ||
Description |
Gets the factor by which the matching amount differs. A factor of 1 matches the amount of the matching controller. | ||
Return | decimal | the factor | |
Errors | ILLEGAL_STATE | executesMatchingSetting() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getMatchingRateFactor | ||
Description |
Gets the factor by which the matching transition rate differs. A factor of 1 matches the ramp rate of the matching controller. | ||
Return | decimal | the factor | |
Errors | ILLEGAL_STATE | executesMatchingSetting() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionRecord | ||
Description |
Gets the action record corresponding to the given
| ||
Parameters | osid.type.Type | actionRecordType | the type of action record to retrieve |
Return | osid.control.records.ActionRecord | the action record | |
Errors | NULL_ARGUMENT | actionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(actionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |