OSID - osid.control.TriggerForm Service Interface Definition

Interface	osid.control.TriggerForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.control.batch.TriggerBatchForm`
Used By	`osid.control.TriggerAdminSession`
Description	This is the form for creating and updating triggers. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `TriggerAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTurnedOnMetadata
Description	Gets the metadata for the ON event listener.
Return	`osid.Metadata`		metadata for the ON event listener
Compliance	`mandatory`		This method must be implemented.
Method	setTurnedOn
Description	Sets the ON event listener.
Parameters	`boolean`	`listen`	true to listen for ON events, false to not listen to ON events
Errors	INVALID_ARGUMENT		`listen` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTurnedOn
Description	Removes the ON event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTurnedOffMetadata
Description	Gets the metadata for the OFF event listener.
Return	`osid.Metadata`		metadata for the OFF event listener
Compliance	`mandatory`		This method must be implemented.
Method	setTurnedOff
Description	Sets the OFF event listener.
Parameters	`boolean`	`listen`	true to listen for OFF events, false to not listen to OFF events
Errors	INVALID_ARGUMENT		`listen` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTurnedOff
Description	Removes the OFF event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getChangedVariableAmountMetadata
Description	Gets the metadata for the changed variable amount event listener.
Return	`osid.Metadata`		metadata for the changed variable amount event listener
Compliance	`mandatory`		This method must be implemented.
Method	setChangedVariableAmount
Description	Sets the changed variable amount event listener.
Parameters	`boolean`	`listen`	true to listen for changed variable amount events, false to not listen to changed variable amount events
Errors	INVALID_ARGUMENT		`listen` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearChangedVariableAmount
Description	Removes the changed variable amount event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getExceedsVariableAmountMetadata
Description	Gets the metadata for the exceeds variable amount event listener.
Return	`osid.Metadata`		metadata for the exceeds variable amount event listener
Compliance	`mandatory`		This method must be implemented.
Method	setExceedsVariableAmount
Description	Sets the exceeds variable amount event listener.
Parameters	`decimal`	`threshold`	the threshold amount
Errors	INVALID_ARGUMENT		`threshold` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`threshold` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExceedsVariableAmount
Description	Removes the exceeds variable amount event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDeceedsVariableAmountMetadata
Description	Gets the metadata for the deceeds variable amount event listener.
Return	`osid.Metadata`		metadata for the deceeds variable amount event listener
Compliance	`mandatory`		This method must be implemented.
Method	setDeceedsVariableAmount
Description	Sets the deceeds variable amount event listener.
Parameters	`decimal`	`threshold`	the threshold amount
Errors	INVALID_ARGUMENT		`threshold` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`threshold` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDeceedsVariableAmount
Description	Removes the deceeds variable amount event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getChangedDiscreetStateMetadata
Description	Gets the metadata for the changed state event listener.
Return	`osid.Metadata`		metadata for the changed state event listener
Compliance	`mandatory`		This method must be implemented.
Method	setChangedDiscreetState
Description	Sets the changed state event listener.
Parameters	`boolean`	`listen`	true to listen for changed state events, false to not listen to changed state events
Errors	INVALID_ARGUMENT		`listen` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearChangedDiscreetState
Description	Removes the changed state event listener.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDiscreetStateMetadata
Description	Gets the metadata for the discreet state event listener.
Return	`osid.Metadata`		metadata for the discreet state event listener
Compliance	`mandatory`		This method must be implemented.
Method	setDiscreetState
Description	Sets the discreet state event listener.
Parameters	`osid.id.Id`	`stateId`	a state `Id`
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDiscreetState
Description	Removes the discreet state.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupsMetadata
Description	Gets the metadata for the action groups.
Return	`osid.Metadata`		metadata for the action groups
Compliance	`mandatory`		This method must be implemented.
Method	setActionGroups
Description	Sets the action groups.
Parameters	`osid.id.Id[]`	`actionGroupIds`	action group `Ids`
Errors	INVALID_ARGUMENT		`actionGroupIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`actionGroupIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActionGroup
Description	Removes the action groups.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScenesMetadata
Description	Gets the metadata for the scenes.
Return	`osid.Metadata`		metadata for the scenes
Compliance	`mandatory`		This method must be implemented.
Method	setScenes
Description	Sets the scenes.
Parameters	`osid.id.Id[]`	`sceneIds`	the scene `Ids`
Errors	INVALID_ARGUMENT		`sceneIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`sceneIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScenes
Description	Removes the scenes.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSettingsMetadata
Description	Gets the metadata for the settings.
Return	`osid.Metadata`		metadata for the settings
Compliance	`mandatory`		This method must be implemented.
Method	setSettings
Description	Sets the settings.
Parameters	`osid.id.Id[]`	`settingIds`	the setting `Ids`
Errors	INVALID_ARGUMENT		`settingIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`settingIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSettings
Description	Removes the settings.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerFormRecord
Description	Gets the `TriggerFormRecord` corresponding to the given trigger record `Type`.
Parameters	`osid.type.Type`	`triggerRecordType`	a trigger record type
Return	`osid.control.records.TriggerFormRecord`		the trigger form 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.