OSID - osid.control.Trigger Service Interface Definition

Interface	osid.control.Trigger
Implements	`osid.OsidRule`
Implements	`osid.Subjugateable`
Used By	`osid.control.TriggerAdminSession`
	`osid.control.TriggerList`
	`osid.control.TriggerLookupSession`
Description	A `Trigger` is an `OsidRule` that listens to events from a `Controller`. The `ActionGroups`, `Scenes` and `Settings` are executed based on the event criteria of the `Trigger`.
Method	getControllerId
Description	Gets the controller `Id`.
Return	`osid.id.Id`		the controller `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getController
Description	Gets the controller.
Return	`osid.control.Controller`		the controller
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	turnedOn
Description	Tests if this trigger listens to controller ON events.
Return	`boolean`		`true` if this is an ON event listener, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	turnedOff
Description	Tests if this trigger listens to controller OFF events.
Return	`boolean`		`true` if this is an OFF event listener, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	changedVariableAmount
Description	Tests if this trigger listens to changed variable amount controller events.
Return	`boolean`		`true` if this is a change event listener, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	changedExceedsVariableAmount
Description	Tests if this trigger listens to events where the variable amount or percentage increased to the same or above this value.
Return	`decimal`		the max threshold
Compliance	`mandatory`		This method must be implemented.
Method	changedDeceedsVariableAmount
Description	Tests if this trigger listens to events where the variable amount or percentage decreased to the same or below this value.
Return	`decimal`		the max threshold
Compliance	`mandatory`		This method must be implemented.
Method	changedDiscreetState
Description	Tests if this trigger listens to controller state changes.
Return	`boolean`		`true` if this is a state change event listener, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	changedToDiscreetState
Description	Tests if this trigger listens to controller events where a state has changed to a specific state.
Return	`boolean`		`true` if this is a state change event, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStateId
Description	Gets the discreet `State` `Id` for a changed state event.
Return	`osid.id.Id`		the state `Id`
Errors	ILLEGAL_STATE		`changedToDiscreetState()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetState
Description	Gets the discreet `State` for a changed state event.
Return	`osid.process.State`		the state
Errors	ILLEGAL_STATE		`changedToDiscreetState()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupIds
Description	Gets the `ActionGroup` `Ids` to execute in this trigger. Multiple action groups can be executed in the order of this list.
Return	`osid.id.IdList`		the action group `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroups
Description	Gets the `ActionGroups` to execute in this trigger. Multiple action groups can be executed in the order of this list.
Return	`osid.control.ActionGroupList`		the action group
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSceneIds
Description	Gets the `Scene` `Ids` to execute in this trigger. Multiple scenes can be executed in the order of this list. This is a shortcut to defining `Actions` and `ActionGroups` which offer more control in scene execution.
Return	`osid.id.IdList`		the scene `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getScenes
Description	Gets the `Scenes` to execute in this trigger. Multiple scenes can be executed in the order of this list. This is a shortcut to defining `Actions` and `ActionGroups` which offer more control in scene execution.
Return	`osid.control.SceneList`		the action group
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSettingIds
Description	Gets the `Setting` `Ids` to execute in this trigger. Multiple settings can be executed in the order of this list. This is a shortcut to defining `Settings`, `Actions` and `ActionGroups` which offer more control in scene and setting execution.
Return	`osid.id.IdList`		the setting `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSettings
Description	Gets the `Settings` to execute in this trigger. Multiple settings can be executed in the order of this list. This is a shortcut to defining `Settings`, `Actions` and `ActionGroups` which offer more control in scene and setting execution.
Return	`osid.control.SettingList`		the action group
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerRecord
Description	Gets the trigger record corresponding to the given `Trigger` record `Type`.This method is used to retrieve an object implementing the requested record. The `triggerRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(triggerRecordType)` is `true`.
Parameters	`osid.type.Type`	`triggerRecordType`	the type of trigger record to retrieve
Return	`osid.control.records.TriggerRecord`		the trigger record
Errors	NULL_ARGUMENT		`triggerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(triggerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.