Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Dictionary] >  [TriggerDefinition]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 19 64 1 2


Summary

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

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%IsA %IsModified %IsNull %KillExtent
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject 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 SummaryClose
SummaryExecute SummaryFetch 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 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 Deprecated as %Boolean [ InitialExpression = 0 ];
True if this trigger is deprecated.
• property Description as %RawString;
Specifies a description of the SQL trigger.
• property Event as %RawString;
Specifies the SQL event that will fire the trigger.
• property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the SQL trigger.
• property Foreach as %RawString;
Indicates if the trigger will be invoked for each row, for rows and objects, or for each statement
• property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
• property Language as %RawString [ SqlFieldName = _Language ];
The language used to implement this trigger.
• property Name as %Dictionary.Identifier [ Required ];
The name of the SQL trigger.
• property NewTable as %RawString;
The name of the SQL table that holds old values for the trigger.
• property OldTable as %RawString;
The name of the SQL table that holds old values for the trigger.
• 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 SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
• property SqlName as %RawString;
Specifies an alternate name when this trigger is used by SQL.
• property Time as %RawString [ SqlFieldName = _Time,InitialExpression = "BEFORE" ];
Specifies whether the trigger is fired before or after the EVENT.
• property UpdateColumnList as %RawString;
Specifies one or more columns whose modification causes the trigger to be pulled by SQL.
• relationship parent as %Dictionary.ClassDefinition [ Inverse = Triggers,Cardinality = parent ];
Pointer to the containing parent object

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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
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
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
This is a Set accessor method for the CodeMode property.
• method CodeReset()
• method CodeSet(value As %String = "") as %Status
This is a Set accessor method for the Code property.
• method DeprecatedIsDefined() as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined() as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "") as %Status
This is a Set accessor method for the Description property.
• method EventIsDefined() as %Boolean
• classmethod EventIsValid(val As %String) as %Status
• method EventReset()
• method EventSet(value As %String = "") as %Status
This is a Set accessor method for the Event property.
• method FinalIsDefined() as %Boolean
• method FinalReset()
• method FinalSet(value As %String = "") as %Status
This is a Set accessor method for the Final property.
• method ForeachIsDefined() as %Boolean
• classmethod ForeachIsValid(val As %String) as %Status
• method ForeachReset()
• method ForeachSet(value As %String = "") as %Status
This is a Set accessor method for the Foreach property.
• method InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal property.
• method LanguageIsDefined() as %Boolean
• classmethod LanguageIsValid(val As %String) as %Status
• method LanguageReset()
• method LanguageSet(value As %String = "") as %Status
This is a Set accessor method for the Language property.
• method NameIsDefined() as %Boolean
• method NameReset()
• method NameSet(value As %String = "") as %Status
This is a Set accessor method for the Name property.
• method NewTableIsDefined() as %Boolean
• method NewTableReset()
• method NewTableSet(value As %String = "") as %Status
This is a Set accessor method for the NewTable property.
• method OldTableIsDefined() as %Boolean
• method OldTableReset()
• method OldTableSet(value As %String = "") as %Status
This is a Set accessor method for the OldTable property.
• method OrderIsDefined() as %Boolean
• method OrderReset()
• method OrderSet(value As %String = "") as %Status
This is a Set accessor method for the Order property.
• method SequenceNumberIsDefined() as %Boolean
• method SequenceNumberReset()
• method SequenceNumberSet(value As %String = "") as %Status
This is a Set accessor method for the SequenceNumber property.
• method SqlNameIsDefined() as %Boolean
• method SqlNameReset()
• method SqlNameSet(value As %String = "") as %Status
This is a Set accessor method for the SqlName property.
• method TimeIsDefined() as %Boolean
• classmethod TimeIsValid(val As %String) as %Status
• method TimeReset()
• method TimeSet(value As %String = "") as %Status
This is a Set accessor method for the Time property.
• method UpdateColumnListIsDefined() as %Boolean
• method UpdateColumnListReset()
• method UpdateColumnListSet(value As %String = "") as %Status
This is a Set accessor method for the UpdateColumnList property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

•trigger OnDelete (AFTER event DELETE)
•trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.