InterSystems IRIS Data Platform 2020.4 > 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 Class Dictionary.

Property Inventory

Method Inventory

Properties

property Attributes as %RawString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
Property methods: AttributesGet(), AttributesSet()
property ClassName as %RawString;
A string containing the name of the class the foreign key belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Deprecated as %RawString;
A flag indicating if this foreign key is deprecated (1) or not (0).
Property methods: DeprecatedGet(), DeprecatedIsValid(), DeprecatedSet()
property Description as %RawString;
A string containing the description of the foreign key.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Internal as %RawString;
A flag indicating whether this trigger is internal (1) or not (0).
Property methods: InternalGet(), InternalIsValid(), InternalSet()
property Name as %RawString;
A string containing the name of the foreign key.
Property methods: NameGet(), NameIsValid(), NameSet()
property OnDelete as %RawString;
The DELETE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
Property methods: OnDeleteGet(), OnDeleteIsValid(), OnDeleteSet()
property OnUpdate as %RawString;
The UPDATE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
Property methods: OnUpdateGet(), OnUpdateIsValid(), OnUpdateSet()
property Properties as %RawString;
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 %RawString;
A string containing the name of the foreign class.
Property methods: ReferencedClassGet(), ReferencedClassIsValid(), ReferencedClassSet()
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 methods: ReferencedKeyGet(), ReferencedKeyIsValid(), ReferencedKeySet()
property SQLName as %RawString;
A string containing the name of this FOREIGNKEY constraint as defined to SQL.
Property methods: SQLNameGet(), SQLNameIsValid(), SQLNameSet()
property SequenceNumber as %RawString;
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 %RawString [ Language = objectscript ]
method AttributesSet(newvalue As %RawString) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%Library.AbstractDefinition)

^%Library.AbstractDefinitionD(ID)
=
%%CLASSNAME
Feedback