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 > ENSLIB namespace > %Dictionary.CompiledForeignKey

%Dictionary.CompiledForeignKey

persistent class %Dictionary.CompiledForeignKey extends %Library.Persistent, %Dictionary.CompiledForeignKeyQuery

SQL Table Name: %Dictionary.CompiledForeignKey

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property CompilerGenerated as %Boolean;
CompilerGenerated
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Deprecated as %Boolean;
True if this foreign key is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Supplies a description of the foreign key.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %Boolean;
Final
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Id as %Integer;
Id
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
InheritedId
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean;
If true then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property KeywordError as %Boolean;
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Name as %Dictionary.CacheIdentifier [ 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(), NameIsValid(), NameSet()
property NoCheck as %Boolean;
NoCheck
Property methods: NoCheckDisplayToLogical(), NoCheckGet(), NoCheckIsValid(), NoCheckLogicalToDisplay(), NoCheckNormalize(), NoCheckSet()
property NotInheritable as %Boolean;
NotInheritable
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property OnDelete as %CacheString;
Specifies what referential action to take when the key value is deleted from the foreign table.
Property methods: OnDeleteExecute(), OnDeleteGet(), OnDeleteIsValid(), OnDeleteSet()
property OnUpdate as %CacheString;
Specifies what referential action to take when the key value is updated in the foreign table.
Property methods: OnUpdateGet(), OnUpdateIsValid(), OnUpdateSet()
property Origin as %CacheString;
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Properties as %CacheString;
Specifies one or more properties whose values are used to constrain the value of the foreign key.
Property methods: PropertiesGet(), PropertiesIsValid(), PropertiesSet()
property ReferencedClass as %Dictionary.CacheClassname;
Specifies the name of the class containing the key referred to by this foreign key definition.
Property methods: ReferencedClassGet(), ReferencedClassIsValid(), ReferencedClassSet()
property ReferencedKey as %CacheString;
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(), ReferencedKeyIsValid(), ReferencedKeySet()
property SequenceNumber as %Integer;
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SqlName as %CacheString;
Specifies an alternate name for this foreign key when referred to via SQL.
Property methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
relationship parent as %Dictionary.CompiledClass [ 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 (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
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 %Library.CacheStorage or %Library.CacheSQLStorage.
private method %OnNew(name As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
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 %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

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

Triggers

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

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window