Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

persistent class %Dictionary.CompiledForeignKey extends %Persistent, %Dictionary.CompiledForeignKeyQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 22 44 1 2


Summary

Properties
CompilerGenerated Deprecated Description Final
Id InheritedId Internal KeywordError
KeywordModified Name NoCheck NotInheritable
OnDelete OnUpdate Origin Properties
ReferencedClass ReferencedKey SequenceNumber SqlName
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 DeprecatedIsDefined DeprecatedReset
DeprecatedSet DescriptionIsDefined DescriptionReset DescriptionSet
InternalIsDefined InternalReset InternalSet NameIsDefined
NameReset NameSet NoCheckIsDefined NoCheckReset
NoCheckSet OnDeleteIsDefined OnDeleteReset OnDeleteSet
OnUpdateIsDefined OnUpdateReset OnUpdateSet PropertiesIsDefined
PropertiesReset PropertiesSet ReferencedClassIsDefined ReferencedClassReset
ReferencedClassSet ReferencedKeyIsDefined ReferencedKeyReset ReferencedKeySet
SequenceNumberIsDefined SequenceNumberReset SequenceNumberSet SqlNameIsDefined
SqlNameReset SqlNameSet SummaryClose SummaryExecute
SummaryFetch parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property CompilerGenerated as %Boolean;
CompilerGenerated
• property Deprecated as %Boolean;
True if this foreign key is deprecated.
• property Description as %RawString;
Supplies a description of the foreign key.
• property Final as %Boolean;
Final
• property Id as %Integer;
Id
• property InheritedId as %Boolean;
InheritedId
• property Internal as %Boolean;
If true then do not display this item in automatic documentation.
• property KeywordError as %Boolean;
KeywordError
• property KeywordModified as %Boolean;
KeywordModified
• property Name as %Dictionary.Identifier [ Required ];
Defines a name for the key. It must be a valid class member name and must not conflict with any existing member name.
• property NoCheck as %Boolean;
NoCheck
• property NotInheritable as %Boolean;
NotInheritable
• property OnDelete as %RawString;
Specifies what referential action to take when the key value is deleted from the foreign table.
• property OnUpdate as %RawString;
Specifies what referential action to take when the key value is updated in the foreign table.
• property Origin as %RawString;
Origin
• property Properties as %RawString;
Specifies one or more properties whose values are used to constrain the value of the foreign key.
• property ReferencedClass as %Dictionary.Classname;
Specifies the name of the class containing the key referred to by this foreign key definition.
• property ReferencedKey as %RawString;
Specifies the key name of a unique index within a class that provides the set of allowed values for this foreign key.
• property SequenceNumber as %Integer;
SequenceNumber
• property SqlName as %RawString;
Specifies an alternate name for this foreign key when referred to via SQL.
• relationship parent as %Dictionary.CompiledClass [ Inverse = ForeignKeys,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 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 InternalIsDefined() as %Boolean
• method InternalReset()
• method InternalSet(value As %String = "") as %Status
This is a Set accessor method for the Internal 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 NoCheckIsDefined() as %Boolean
• method NoCheckReset()
• method NoCheckSet(value As %String = "") as %Status
This is a Set accessor method for the NoCheck property.
• method OnDeleteIsDefined() as %Boolean
• method OnDeleteReset()
• method OnDeleteSet(value As %String = "") as %Status
This is a Set accessor method for the OnDelete property.
• method OnUpdateIsDefined() as %Boolean
• method OnUpdateReset()
• method OnUpdateSet(value As %String = "") as %Status
This is a Set accessor method for the OnUpdate property.
• method PropertiesIsDefined() as %Boolean
• method PropertiesReset()
• method PropertiesSet(value As %String = "") as %Status
This is a Set accessor method for the Properties property.
• method ReferencedClassIsDefined() as %Boolean
• method ReferencedClassReset()
• method ReferencedClassSet(value As %String = "") as %Status
This is a Set accessor method for the ReferencedClass property.
• method ReferencedKeyIsDefined() as %Boolean
• method ReferencedKeyReset()
• method ReferencedKeySet(value As %String = "") as %Status
This is a Set accessor method for the ReferencedKey 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.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

•trigger OnDelete (BEFORE 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.