Interface TriggerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

TriggerBatchForm

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.

Method Summary

Modifier and Type	Method	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(BigDecimal threshold)	Sets the deceeds variable amount event listener.
void	setDiscreetState(Id stateId)	Sets the discreet state event listener.
void	setExceedsVariableAmount(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getTurnedOnMetadata

Metadata getTurnedOnMetadata()

Gets the metadata for the ON event listener.

Returns:

metadata for the ON event listener

Compliance:

mandatory - This method must be implemented.

setTurnedOn

void setTurnedOn(boolean listen)

Sets the ON event listener.

Parameters:

listen - true to listen for ON events, false to not listen to ON events

Throws:

InvalidArgumentException - listen is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTurnedOn

void clearTurnedOn()

Removes the ON event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTurnedOffMetadata

Metadata getTurnedOffMetadata()

Gets the metadata for the OFF event listener.

Returns:

metadata for the OFF event listener

Compliance:

mandatory - This method must be implemented.

setTurnedOff

void setTurnedOff(boolean listen)

Sets the OFF event listener.

Parameters:

listen - true to listen for OFF events, false to not listen to OFF events

Throws:

InvalidArgumentException - listen is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTurnedOff

void clearTurnedOff()

Removes the OFF event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getChangedVariableAmountMetadata

Metadata getChangedVariableAmountMetadata()

Gets the metadata for the changed variable amount event listener.

Returns:

metadata for the changed variable amount event listener

Compliance:

mandatory - This method must be implemented.

setChangedVariableAmount

void setChangedVariableAmount(boolean listen)

Sets the changed variable amount event listener.

Parameters:

listen - true to listen for changed variable amount events, false to not listen to changed variable amount events

Throws:

InvalidArgumentException - listen is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearChangedVariableAmount

void clearChangedVariableAmount()

Removes the changed variable amount event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getExceedsVariableAmountMetadata

Metadata getExceedsVariableAmountMetadata()

Gets the metadata for the exceeds variable amount event listener.

Returns:

metadata for the exceeds variable amount event listener

Compliance:

mandatory - This method must be implemented.

setExceedsVariableAmount

void setExceedsVariableAmount(BigDecimal threshold)

Sets the exceeds variable amount event listener.

Parameters:

threshold - the threshold amount

Throws:

InvalidArgumentException - threshold is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - threshold is null

Compliance:

mandatory - This method must be implemented.

clearExceedsVariableAmount

void clearExceedsVariableAmount()

Removes the exceeds variable amount event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDeceedsVariableAmountMetadata

Metadata getDeceedsVariableAmountMetadata()

Gets the metadata for the deceeds variable amount event listener.

Returns:

metadata for the deceeds variable amount event listener

Compliance:

mandatory - This method must be implemented.

setDeceedsVariableAmount

void setDeceedsVariableAmount(BigDecimal threshold)

Sets the deceeds variable amount event listener.

Parameters:

threshold - the threshold amount

Throws:

InvalidArgumentException - threshold is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - threshold is null

Compliance:

mandatory - This method must be implemented.

clearDeceedsVariableAmount

void clearDeceedsVariableAmount()

Removes the deceeds variable amount event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getChangedDiscreetStateMetadata

Metadata getChangedDiscreetStateMetadata()

Gets the metadata for the changed state event listener.

Returns:

metadata for the changed state event listener

Compliance:

mandatory - This method must be implemented.

setChangedDiscreetState

void setChangedDiscreetState(boolean listen)

Sets the changed state event listener.

Parameters:

listen - true to listen for changed state events, false to not listen to changed state events

Throws:

InvalidArgumentException - listen is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearChangedDiscreetState

void clearChangedDiscreetState()

Removes the changed state event listener.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDiscreetStateMetadata

Metadata getDiscreetStateMetadata()

Gets the metadata for the discreet state event listener.

Returns:

metadata for the discreet state event listener

Compliance:

mandatory - This method must be implemented.

setDiscreetState

void setDiscreetState(Id stateId)

Sets the discreet state event listener.

Parameters:

stateId - a state Id

Throws:

InvalidArgumentException - stateId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearDiscreetState

void clearDiscreetState()

Removes the discreet state.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActionGroupsMetadata

Metadata getActionGroupsMetadata()

Gets the metadata for the action groups.

Returns:

metadata for the action groups

Compliance:

mandatory - This method must be implemented.

setActionGroups

void setActionGroups(Id[] actionGroupIds)

Sets the action groups.

Parameters:

actionGroupIds - action group Ids

Throws:

InvalidArgumentException - actionGroupIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - actionGroupIds is null

Compliance:

mandatory - This method must be implemented.

clearActionGroup

void clearActionGroup()

Removes the action groups.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScenesMetadata

Metadata getScenesMetadata()

Gets the metadata for the scenes.

Returns:

metadata for the scenes

Compliance:

mandatory - This method must be implemented.

setScenes

void setScenes(Id[] sceneIds)

Sets the scenes.

Parameters:

sceneIds - the scene Ids

Throws:

InvalidArgumentException - sceneIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - sceneIds is null

Compliance:

mandatory - This method must be implemented.

clearScenes

void clearScenes()

Removes the scenes.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSettingsMetadata

Metadata getSettingsMetadata()

Gets the metadata for the settings.

Returns:

metadata for the settings

Compliance:

mandatory - This method must be implemented.

setSettings

void setSettings(Id[] settingIds)

Sets the settings.

Parameters:

settingIds - the setting Ids

Throws:

InvalidArgumentException - settingIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - settingIds is null

Compliance:

mandatory - This method must be implemented.

clearSettings

void clearSettings()

Removes the settings.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTriggerFormRecord

TriggerFormRecord getTriggerFormRecord(Type triggerRecordType)
                                throws OperationFailedException

Gets the TriggerFormRecord corresponding to the given trigger record Type .

Parameters:

triggerRecordType - a trigger record type

Returns:

the trigger form record

Throws:

NullArgumentException - triggerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerRecordType) is false

Compliance:

mandatory - This method must be implemented.