OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerForm
Implementsosid.OsidRuleForm
osid.OsidSubjugateableForm
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.

MethodgetTurnedOnMetadata
Description

Gets the metadata for the ON event listener.

Returnosid.Metadatametadata for the ON event listener
CompliancemandatoryThis method must be implemented.
MethodsetTurnedOn
Description

Sets the ON event listener.

Parametersbooleanlistentrue to listen for ON events, false to not listen to ON events
ErrorsINVALID_ARGUMENT listen is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearTurnedOn
Description

Removes the ON event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTurnedOffMetadata
Description

Gets the metadata for the OFF event listener.

Returnosid.Metadatametadata for the OFF event listener
CompliancemandatoryThis method must be implemented.
MethodsetTurnedOff
Description

Sets the OFF event listener.

Parametersbooleanlistentrue to listen for OFF events, false to not listen to OFF events
ErrorsINVALID_ARGUMENT listen is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearTurnedOff
Description

Removes the OFF event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetChangedVariableAmountMetadata
Description

Gets the metadata for the changed variable amount event listener.

Returnosid.Metadatametadata for the changed variable amount event listener
CompliancemandatoryThis method must be implemented.
MethodsetChangedVariableAmount
Description

Sets the changed variable amount event listener.

Parametersbooleanlistentrue to listen for changed variable amount events, false to not listen to changed variable amount events
ErrorsINVALID_ARGUMENT listen is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearChangedVariableAmount
Description

Removes the changed variable amount event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetExceedsVariableAmountMetadata
Description

Gets the metadata for the exceeds variable amount event listener.

Returnosid.Metadatametadata for the exceeds variable amount event listener
CompliancemandatoryThis method must be implemented.
MethodsetExceedsVariableAmount
Description

Sets the exceeds variable amount event listener.

Parametersdecimalthresholdthe threshold amount
ErrorsINVALID_ARGUMENT threshold is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT threshold is null
CompliancemandatoryThis method must be implemented.
MethodclearExceedsVariableAmount
Description

Removes the exceeds variable amount event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDeceedsVariableAmountMetadata
Description

Gets the metadata for the deceeds variable amount event listener.

Returnosid.Metadatametadata for the deceeds variable amount event listener
CompliancemandatoryThis method must be implemented.
MethodsetDeceedsVariableAmount
Description

Sets the deceeds variable amount event listener.

Parametersdecimalthresholdthe threshold amount
ErrorsINVALID_ARGUMENT threshold is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT threshold is null
CompliancemandatoryThis method must be implemented.
MethodclearDeceedsVariableAmount
Description

Removes the deceeds variable amount event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetChangedDiscreetStateMetadata
Description

Gets the metadata for the changed state event listener.

Returnosid.Metadatametadata for the changed state event listener
CompliancemandatoryThis method must be implemented.
MethodsetChangedDiscreetState
Description

Sets the changed state event listener.

Parametersbooleanlistentrue to listen for changed state events, false to not listen to changed state events
ErrorsINVALID_ARGUMENT listen is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearChangedDiscreetState
Description

Removes the changed state event listener.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetStateMetadata
Description

Gets the metadata for the discreet state event listener.

Returnosid.Metadatametadata for the discreet state event listener
CompliancemandatoryThis method must be implemented.
MethodsetDiscreetState
Description

Sets the discreet state event listener.

Parametersosid.id.IdstateIda state Id
ErrorsINVALID_ARGUMENT stateId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetState
Description

Removes the discreet state.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupsMetadata
Description

Gets the metadata for the action groups.

Returnosid.Metadatametadata for the action groups
CompliancemandatoryThis method must be implemented.
MethodsetActionGroups
Description

Sets the action groups.

Parametersosid.id.Id[]actionGroupIdsaction group Ids
ErrorsINVALID_ARGUMENT actionGroupIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT actionGroupIds is null
CompliancemandatoryThis method must be implemented.
MethodclearActionGroup
Description

Removes the action groups.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetScenesMetadata
Description

Gets the metadata for the scenes.

Returnosid.Metadatametadata for the scenes
CompliancemandatoryThis method must be implemented.
MethodsetScenes
Description

Sets the scenes.

Parametersosid.id.Id[]sceneIdsthe scene Ids
ErrorsINVALID_ARGUMENT sceneIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT sceneIds is null
CompliancemandatoryThis method must be implemented.
MethodclearScenes
Description

Removes the scenes.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSettingsMetadata
Description

Gets the metadata for the settings.

Returnosid.Metadatametadata for the settings
CompliancemandatoryThis method must be implemented.
MethodsetSettings
Description

Sets the settings.

Parametersosid.id.Id[]settingIdsthe setting Ids
ErrorsINVALID_ARGUMENT settingIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT settingIds is null
CompliancemandatoryThis method must be implemented.
MethodclearSettings
Description

Removes the settings.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTriggerFormRecord
Description

Gets the TriggerFormRecord corresponding to the given trigger record Type.

Parametersosid.type.TypetriggerRecordTypea trigger record type
Returnosid.control.records.TriggerFormRecordthe trigger form record
ErrorsNULL_ARGUMENT triggerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(triggerRecordType) is false
CompliancemandatoryThis method must be implemented.