%Dictionary.ForeignKeyDefinition

persistent class %Dictionary.ForeignKeyDefinition extends %Library.Persistent, %Dictionary.ForeignKeyDefinitionQuery

SQL Table Name: %Dictionary.ForeignKeyDefinition

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this foreign key is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Supplies a description of the foreign key.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property Internal as %Boolean [ InitialExpression = 0 ];
If true then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsDefined(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalReset(), InternalSet()
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 methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NoCheck as %Boolean [ InitialExpression = 0 ];
NoCheck
Property methods: NoCheckDisplayToLogical(), NoCheckGet(), NoCheckIsDefined(), NoCheckIsValid(), NoCheckLogicalToDisplay(), NoCheckNormalize(), NoCheckReset(), NoCheckSet()
property OnDelete as %RawString [ InitialExpression = "noaction" ];
Specifies what referential action to take when the key value is deleted from the foreign table.
Property methods: OnDeleteExecute(), OnDeleteGet(), OnDeleteIsDefined(), OnDeleteIsValid(), OnDeleteReset(), OnDeleteSet()
property OnUpdate as %RawString [ InitialExpression = "noaction" ];
Specifies what referential action to take when the key value is updated in the foreign table.
Property methods: OnUpdateGet(), OnUpdateIsDefined(), OnUpdateIsValid(), OnUpdateReset(), OnUpdateSet()
property Properties as %RawString;
Specifies one or more properties whose values are used to constrain the value of the foreign key.
Property methods: PropertiesGet(), PropertiesIsDefined(), PropertiesIsValid(), PropertiesReset(), PropertiesSet()
property ReferencedClass as %Dictionary.Classname;
Specifies the name of the class containing the key referred to by this foreign key definition.
Property methods: ReferencedClassGet(), ReferencedClassIsDefined(), ReferencedClassIsValid(), ReferencedClassReset(), ReferencedClassSet()
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 methods: ReferencedKeyGet(), ReferencedKeyIsDefined(), ReferencedKeyIsValid(), ReferencedKeyReset(), ReferencedKeySet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsDefined(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberReset(), SequenceNumberSet()
property SqlName as %RawString;
Specifies an alternate name for this foreign key when referred to via SQL.
Property methods: SqlNameGet(), SqlNameIsDefined(), SqlNameIsValid(), SqlNameReset(), SqlNameSet()
relationship parent as %Dictionary.ClassDefinition [ Required , Inverse = ForeignKeys , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method NoCheckIsDefined() as %Boolean [ Language = objectscript ]
method NoCheckReset() [ Language = objectscript ]
method NoCheckSet(value As %String = "") as %Status [ Language = objectscript ]
method OnDeleteIsDefined() as %Boolean [ Language = objectscript ]
classmethod OnDeleteIsValid(val As %String) as %Status [ Language = objectscript ]
method OnDeleteReset() [ Language = objectscript ]
method OnDeleteSet(value As %String = "") as %Status [ Language = objectscript ]
method OnUpdateIsDefined() as %Boolean [ Language = objectscript ]
classmethod OnUpdateIsValid(val As %String) as %Status [ Language = objectscript ]
method OnUpdateReset() [ Language = objectscript ]
method OnUpdateSet(value As %String = "") as %Status [ Language = objectscript ]
method PropertiesIsDefined() as %Boolean [ Language = objectscript ]
method PropertiesReset() [ Language = objectscript ]
method PropertiesSet(value As %String = "") as %Status [ Language = objectscript ]
method ReferencedClassIsDefined() as %Boolean [ Language = objectscript ]
method ReferencedClassReset() [ Language = objectscript ]
method ReferencedClassSet(value As %String = "") as %Status [ Language = objectscript ]
method ReferencedKeyIsDefined() as %Boolean [ Language = objectscript ]
method ReferencedKeyReset() [ Language = objectscript ]
method ReferencedKeySet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlNameReset() [ Language = objectscript ]
method SqlNameSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]

Indexes

index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

trigger OnDelete (AFTER event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

Feedback