public interface TriggerForm extends OsidRuleForm, OsidSubjugateableForm
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.
Modifier and Type | Method and Description |
---|---|
void |
clearActionGroup()
Removes the action groups.
|
void |
clearChangedDiscreetState()
Removes the changed state event listener.
|
void |
clearChangedVariableAmount()
Removes the changed variable amount event listener.
|
void |
clearDeceedsVariableAmount()
Removes the deceeds variable amount event listener.
|
void |
clearDiscreetState()
Removes the discreet state.
|
void |
clearExceedsVariableAmount()
Removes the exceeds variable amount event listener.
|
void |
clearScenes()
Removes the scenes.
|
void |
clearSettings()
Removes the settings.
|
void |
clearTurnedOff()
Removes the OFF event listener.
|
void |
clearTurnedOn()
Removes the ON event listener.
|
Metadata |
getActionGroupsMetadata()
Gets the metadata for the action groups.
|
Metadata |
getChangedDiscreetStateMetadata()
Gets the metadata for the changed state event listener.
|
Metadata |
getChangedVariableAmountMetadata()
Gets the metadata for the changed variable amount event listener.
|
Metadata |
getDeceedsVariableAmountMetadata()
Gets the metadata for the deceeds variable amount event listener.
|
Metadata |
getDiscreetStateMetadata()
Gets the metadata for the discreet state event listener.
|
Metadata |
getExceedsVariableAmountMetadata()
Gets the metadata for the exceeds variable amount event listener.
|
Metadata |
getScenesMetadata()
Gets the metadata for the scenes.
|
Metadata |
getSettingsMetadata()
Gets the metadata for the settings.
|
TriggerFormRecord |
getTriggerFormRecord(Type triggerRecordType)
Gets the
TriggerFormRecord corresponding to the given
trigger record Type. |
Metadata |
getTurnedOffMetadata()
Gets the metadata for the OFF event listener.
|
Metadata |
getTurnedOnMetadata()
Gets the metadata for the ON event listener.
|
void |
setActionGroups(Id[] actionGroupIds)
Sets the action groups.
|
void |
setChangedDiscreetState(boolean listen)
Sets the changed state event listener.
|
void |
setChangedVariableAmount(boolean listen)
Sets the changed variable amount event listener.
|
void |
setDeceedsVariableAmount(java.math.BigDecimal threshold)
Sets the deceeds variable amount event listener.
|
void |
setDiscreetState(Id stateId)
Sets the discreet state event listener.
|
void |
setExceedsVariableAmount(java.math.BigDecimal threshold)
Sets the exceeds variable amount event listener.
|
void |
setScenes(Id[] sceneIds)
Sets the scenes.
|
void |
setSettings(Id[] settingIds)
Sets the settings.
|
void |
setTurnedOff(boolean listen)
Sets the OFF event listener.
|
void |
setTurnedOn(boolean listen)
Sets the ON event listener.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getTurnedOnMetadata()
mandatory
- This method must be implemented. void setTurnedOn(boolean listen)
listen
- true to listen for ON events, false to not listen to ON
eventsInvalidArgumentException
- listen
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearTurnedOn()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTurnedOffMetadata()
mandatory
- This method must be implemented. void setTurnedOff(boolean listen)
listen
- true to listen for OFF events, false to not listen to
OFF eventsInvalidArgumentException
- listen
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearTurnedOff()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getChangedVariableAmountMetadata()
mandatory
- This method must be implemented. void setChangedVariableAmount(boolean listen)
listen
- true to listen for changed variable amount events,
false to not listen to changed variable amount eventsInvalidArgumentException
- listen
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearChangedVariableAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getExceedsVariableAmountMetadata()
mandatory
- This method must be implemented. void setExceedsVariableAmount(java.math.BigDecimal threshold)
threshold
- the threshold amountInvalidArgumentException
- threshold
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- threshold
is
null
mandatory
- This method must be implemented. void clearExceedsVariableAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDeceedsVariableAmountMetadata()
mandatory
- This method must be implemented. void setDeceedsVariableAmount(java.math.BigDecimal threshold)
threshold
- the threshold amountInvalidArgumentException
- threshold
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- threshold
is
null
mandatory
- This method must be implemented. void clearDeceedsVariableAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getChangedDiscreetStateMetadata()
mandatory
- This method must be implemented. void setChangedDiscreetState(boolean listen)
listen
- true to listen for changed state events, false to not
listen to changed state eventsInvalidArgumentException
- listen
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearChangedDiscreetState()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDiscreetStateMetadata()
mandatory
- This method must be implemented. void setDiscreetState(Id stateId)
stateId
- a state Id
InvalidArgumentException
- stateId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDiscreetState()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getActionGroupsMetadata()
mandatory
- This method must be implemented. void setActionGroups(Id[] actionGroupIds)
actionGroupIds
- action group Ids
InvalidArgumentException
- actionGroupIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- actionGroupIds
is null
mandatory
- This method must be implemented. void clearActionGroup()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScenesMetadata()
mandatory
- This method must be implemented. void setScenes(Id[] sceneIds)
sceneIds
- the scene Ids
InvalidArgumentException
- sceneIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- sceneIds
is
null
mandatory
- This method must be implemented. void clearScenes()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSettingsMetadata()
mandatory
- This method must be implemented. void setSettings(Id[] settingIds)
settingIds
- the setting Ids
InvalidArgumentException
- settingIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- settingIds
is
null
mandatory
- This method must be implemented. void clearSettings()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. TriggerFormRecord getTriggerFormRecord(Type triggerRecordType) throws OperationFailedException
TriggerFormRecord
corresponding to the given
trigger record Type.
triggerRecordType
- a trigger record typeNullArgumentException
- triggerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(triggerRecordType)
is false
mandatory
- This method must be implemented.