Class %Dictionary.CompiledForeignKey

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	20	7		1		2

Summary

Properties
CompilerGenerated	Description	Final	Id
InheritedId	Internal	KeywordError	KeywordModified
Name	NoCheck	NotInheritable	OnDelete
OnUpdate	Origin	Properties	ReferencedClass
ReferencedKey	SequenceNumber	SqlName	parent

Methods
%%OIDGet	%AddToSaveSet	%AddToSyncSet	%BuildIndices
%CheckUnique	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%IsA	%IsModified	%KillExtent	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDetermineClass	%Open
%OpenId	%OriginalNamespace	%PackageName	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SerializeObject	%SetModified
%SortBegin	%SortEnd	%SyncObjectIn	%SyncTransport
%UnlockExtent	%UnlockId	%ValidateObject	SummaryClose
SummaryExecute	SummaryFetch

Parameters

• parameter SQLENABLED = 1;

Properties

• property CompilerGenerated as %Boolean;

CompilerGenerated

• property Description as %CacheString;

Supplies a description of the foreign key.

• property Final as %Boolean;

Final

• property Id as %Integer;

Id

• property InheritedId as %Boolean;

InheritedId

• property Internal as %Boolean;

If true then do not display this item in automatic documentation.

• property KeywordError as %Boolean;

KeywordError

• property KeywordModified as %Boolean;

KeywordModified

• property Name as %Dictionary.CacheIdentifier;

Defines a name for the key. It must be a valid class member name and must not conflict with any existing member name.

• property NoCheck as %Boolean;

NoCheck

• property NotInheritable as %Boolean;

NotInheritable

• property OnDelete as %CacheString;

Specifies what referential action to take when the key value is deleted from the foreign table.

• property OnUpdate as %CacheString;

Specifies what referential action to take when the key value is updated in the foreign table.

• property Origin as %CacheString;

Origin

• property Properties as %CacheString;

Specifies one or more properties whose values are used to constrain the value of the foreign key.

• property ReferencedClass as %Dictionary.CacheClassname;

Specifies the name of the class containing the key referred to by this foreign key definition.

• 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 SequenceNumber as %Integer;

SequenceNumber

• property SqlName as %CacheString;

Specifies an alternate name for this foreign key when referred to via SQL.

• relationship parent as %Dictionary.CompiledClass [ Inverse = ForeignKeys,Cardinality = parent ];

Pointer to the containing parent object

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean

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) as %Status

%LockId() 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.

• classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status

%UnlockId() 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.

Indices

• index (IDKEY on Name) [IdKey];

Triggers

• trigger OnDelete (BEFORE event DELETE)

• trigger OnInsertUpdate (BEFORE event INSERT/UPDATE)


[BASEXML] > [%Dictionary] > [CompiledForeignKey]		Private Storage