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 Caché Dictionary.
For more information on class definition classes, refer to
About Class Definition Classes.
• property Attributes
as %CacheString [ Calculated ];
This attribute is obsolete. Use 'Properties' instead.
• property ClassName
as %CacheString;
A string containing the name of the class the foreign key belongs to.
• property Description
as %CacheString;
A string containing the description of the foreign key.
• property Internal
as %CacheString;
A flag indicating whether this trigger is internal (1) or not (0).
• property Name
as %CacheString;
A string containing the name of the foreign key.
• property OnDelete
as %CacheString;
The DELETE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
• property OnUpdate
as %CacheString;
The UPDATE referential action: NOACTION, CASCADE, SETDEFAULT, SETNULL.
• property Properties
as %CacheString;
A string containing a comma-delimited list of attributes in the class that
form the foreign key reference.
• property ReferencedClass
as %CacheString;
A string containing the name of the foreign class.
• 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 SQLName
as %CacheString;
A string containing the name of this FOREIGNKEY constraint as defined to SQL.
• property SequenceNumber
as %CacheString;
Sequence number used to determine order of this item in Studio editor and in XML export format.
