This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Library.ForeignKeyDefinition

%Library.ForeignKeyDefinition

persistent class %Library.ForeignKeyDefinition extends %Library.AbstractDefinition

SQL Table Name: %Library.ForeignKeyDefinition

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 Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory

Method Inventory

Properties

property Attributes as %CacheString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
Property methods: AttributesGet(), AttributesSet()
property ClassName as %CacheString;
A string containing the name of the class the foreign key belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Description as %CacheString;
A string containing the description of the foreign key.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Internal as %CacheString;
A flag indicating whether this trigger is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Name as %CacheString;
A string containing the name of the foreign key.
Property methods: NameGet(), NameIsValid(), NameSet()
property OnDelete as %CacheString;
The DELETE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
Property methods: OnDeleteGet(), OnDeleteIsValid(), OnDeleteSet()
property OnUpdate as %CacheString;
The UPDATE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
Property methods: OnUpdateGet(), OnUpdateIsValid(), OnUpdateSet()
property Properties as %CacheString;
A string containing a comma-delimited list of attributes in the class that form the foreign key reference.
Property methods: PropertiesGet(), PropertiesIsValid(), PropertiesSet()
property ReferencedClass as %CacheString;
A string containing the name of the foreign class.
Property methods: ReferencedClassGet(), ReferencedClassIsValid(), ReferencedClassSet()
property ReferencedKey as %CacheString;
A string containing the name of the foreign index. If omitted, it defaults to the index declared to be IDKEY.
Property methods: ReferencedKeyGet(), ReferencedKeyIsValid(), ReferencedKeySet()
property SQLName as %CacheString;
A string containing the name of this FOREIGNKEY constraint as defined to SQL.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property SequenceNumber as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
Property methods: SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberSet()

Methods

method AttributesGet() as %CacheString
method AttributesSet(newvalue As %CacheString) as %Status

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (%Library.AbstractDefinition)

^%Library.AbstractDefinitionD(ID)
=
%%CLASSNAME
FeedbackOpens in a new window