Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Library] >  [ForeignKeyDefinition]
Private  Storage   

persistent class %Library.ForeignKeyDefinition extends %AbstractDefinition

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific foreign key description for a class contained within the Class Dictionary.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
13 7


Summary

Properties
Attributes ClassName Deprecated Description
Internal Name OnDelete OnUpdate
Properties ReferencedClass ReferencedKey SQLName
SequenceNumber

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %BuildIndicesAsync
%BuildIndicesAsyncResponse %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
AttributesGet AttributesSet GetTransientState SetTransientState
lb li ll


Properties

• property Attributes as %RawString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
• property ClassName as %RawString;
A string containing the name of the class the foreign key belongs to.
• property Deprecated as %RawString;
A flag indicating if this foreign key is deprecated (1) or not (0).
• property Description as %RawString;
A string containing the description of the foreign key.
• property Internal as %RawString;
A flag indicating whether this trigger is internal (1) or not (0).
• property Name as %RawString;
A string containing the name of the foreign key.
• property OnDelete as %RawString;
The DELETE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
• property OnUpdate as %RawString;
The UPDATE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
• property Properties as %RawString;
A string containing a comma-delimited list of attributes in the class that form the foreign key reference.
• property ReferencedClass as %RawString;
A string containing the name of the foreign class.
• property ReferencedKey as %RawString;
A string containing the name of the foreign index. If omitted, it defaults to the index declared to be IDKEY.
• property SQLName as %RawString;
A string containing the name of this FOREIGNKEY constraint as defined to SQL.
• property SequenceNumber as %RawString;
Sequence number used to determine order of this item in Studio editor and in XML export format.

Methods

• method AttributesGet() as %RawString
This is a Get accessor method for the Attributes property.
• method AttributesSet(newvalue As %RawString) as %Status
This is a Set accessor method for the Attributes property.


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