%Dictionary.TriggerDefinition

persistent class %Dictionary.TriggerDefinition extends %Library.Persistent, %Dictionary.TriggerDefinitionQuery

SQL Table Name: %Dictionary.TriggerDefinition

Property Inventory

Code
CodeMode
Deprecated
Description
Event
Final
Foreach
Internal
Language
Name
NewTable
OldTable
Order
SequenceNumber
SqlName
Time
UpdateColumnList
parent

Method Inventory

%Exists()
%LockId()
%UnlockId()
CodeIsDefined()
CodeModeIsDefined()
CodeModeIsValid()
CodeModeReset()
CodeModeSet()
CodeReset()
CodeSet()
DeprecatedIsDefined()
DeprecatedReset()
DeprecatedSet()
DescriptionIsDefined()
DescriptionReset()
DescriptionSet()
EventIsDefined()
EventIsValid()
EventReset()
EventSet()
FinalIsDefined()
FinalReset()
FinalSet()
ForeachIsDefined()
ForeachIsValid()
ForeachReset()
ForeachSet()
InternalIsDefined()
InternalReset()
InternalSet()
LanguageIsDefined()
LanguageIsValid()
LanguageReset()
LanguageSet()
NameIsDefined()
NameReset()
NameSet()
NewTableIsDefined()
NewTableReset()
NewTableSet()
OldTableIsDefined()
OldTableReset()
OldTableSet()
OrderIsDefined()
OrderReset()
OrderSet()
SequenceNumberIsDefined()
SequenceNumberReset()
SequenceNumberSet()
SqlNameIsDefined()
SqlNameReset()
SqlNameSet()
TimeIsDefined()
TimeIsValid()
TimeReset()
TimeSet()
UpdateColumnListIsDefined()
UpdateColumnListReset()
UpdateColumnListSet()
parentOnDelete()

Parameters

parameter SQLENABLED = 1;

Properties

property Code as %RawString;

The code that is executed when the trigger is fired.

Property methods: CodeGet(), CodeIsValid()

property CodeMode as %RawString [ InitialExpression = "code" ];

Specifies how a given method is implemented: lines of code to be compiled, or a method that will generate the resulting method or object.

Property methods: CodeModeGet()

property Deprecated as %Boolean [ InitialExpression = 0 ];

True if this trigger is deprecated.

Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()

property Description as %RawString;

Specifies a description of the SQL trigger.

Property methods: DescriptionGet(), DescriptionIsValid()

property Event as %RawString;

Specifies the SQL event that will fire the trigger.

Property methods: EventGet()

property Final as %Boolean [ InitialExpression = 0 ];

Specifies that subclasses cannot override the definition of the SQL trigger.

Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize()

property Foreach as %RawString;

Indicates if the trigger will be invoked for each row, for rows and objects, or for each statement

Property methods: ForeachGet()

property Internal as %Boolean [ InitialExpression = 0 ];

If true, then do not display this item in automatic documentation.

Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize()

property Language as %RawString [ SqlFieldName = _Language ];

The language used to implement this trigger.

Property methods: LanguageGet()

property Name as %Dictionary.Identifier [ Required ];

The name of the SQL trigger.

Property methods: NameGet(), NameIsValid()

property NewTable as %RawString;

The name of the SQL table that holds old values for the trigger.

Property methods: NewTableGet(), NewTableIsValid()

property OldTable as %RawString;

The name of the SQL table that holds old values for the trigger.

Property methods: OldTableGet(), OldTableIsValid()

property Order as %Integer [ InitialExpression = 0 ];

In the case of multiple triggers for the same EVENT and TIME, specifies the order in which the triggers should be fired.

Property methods: OrderDisplayToLogical(), OrderGet(), OrderIsValid(), OrderLogicalToDisplay(), OrderNormalize()

property SequenceNumber as %Integer [ InitialExpression = 0 ];

SequenceNumber

Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize()

property SqlName as %RawString;

Specifies an alternate name when this trigger is used by SQL.

Property methods: SqlNameGet(), SqlNameIsValid()

property Time as %RawString [ SqlFieldName = _Time , InitialExpression = "BEFORE" ];

Specifies whether the trigger is fired before or after the EVENT.

Property methods: TimeGet()

property UpdateColumnList as %RawString;

Specifies one or more columns whose modification causes the trigger to be pulled by SQL.

Property methods: UpdateColumnListGet(), UpdateColumnListIsValid()

relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = Triggers , Cardinality = parent ];

Pointer to the containing parent object

Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean

Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status

Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.

classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status

Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.

method CodeIsDefined() as %Boolean

method CodeModeIsDefined() as %Boolean

classmethod CodeModeIsValid(val As %String) as %Status

method CodeModeReset()

method CodeModeSet(value As %String = "") as %Status

method CodeReset()

method CodeSet(value As %String = "") as %Status

method DeprecatedIsDefined() as %Boolean

method DeprecatedReset()

method DeprecatedSet(value As %String = "") as %Status

method DescriptionIsDefined() as %Boolean

method DescriptionReset()

method DescriptionSet(value As %String = "") as %Status

method EventIsDefined() as %Boolean

classmethod EventIsValid(val As %String) as %Status

method EventReset()

method EventSet(value As %String = "") as %Status

method FinalIsDefined() as %Boolean

method FinalReset()

method FinalSet(value As %String = "") as %Status

method ForeachIsDefined() as %Boolean

classmethod ForeachIsValid(val As %String) as %Status

method ForeachReset()

method ForeachSet(value As %String = "") as %Status

method InternalIsDefined() as %Boolean

method InternalReset()

method InternalSet(value As %String = "") as %Status

method LanguageIsDefined() as %Boolean

classmethod LanguageIsValid(val As %String) as %Status

method LanguageReset()

method LanguageSet(value As %String = "") as %Status

method NameIsDefined() as %Boolean

method NameReset()

method NameSet(value As %String = "") as %Status

method NewTableIsDefined() as %Boolean

method NewTableReset()

method NewTableSet(value As %String = "") as %Status

method OldTableIsDefined() as %Boolean

method OldTableReset()

method OldTableSet(value As %String = "") as %Status

method OrderIsDefined() as %Boolean

method OrderReset()

method OrderSet(value As %String = "") as %Status

method SequenceNumberIsDefined() as %Boolean

method SequenceNumberReset()

method SequenceNumberSet(value As %String = "") as %Status

method SqlNameIsDefined() as %Boolean

method SqlNameReset()

method SqlNameSet(value As %String = "") as %Status

method TimeIsDefined() as %Boolean

classmethod TimeIsValid(val As %String) as %Status

method TimeReset()

method TimeSet(value As %String = "") as %Status

method UpdateColumnListIsDefined() as %Boolean

method UpdateColumnListReset()

method UpdateColumnListSet(value As %String = "") as %Status

classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

index (IDKEY on Name) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()