Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage   

persistent class %Dictionary.CompiledConstraint extends %Persistent, %Dictionary.CompiledConstraintQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 22 11 1 2


Summary

Properties
Category CompilerGenerated Deferrable Deprecated
Final FormalSpec FormalSpecParsed GeneratedFrom
Id InheritedId Initialmode KeywordError
KeywordModified Methods Name NotInheritable
Origin Parameters SqlName Type
parent

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %CheckConstraints
%CheckConstraintsForExtent %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 %IsNull %KillExtent
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject DeprecatedIsDefined DeprecatedReset
DeprecatedSet SummaryClose SummaryExecute SummaryFetch
parentOnDelete


Parameters

• parameter SQLENABLED = 1;

Properties

• property Category as %RawString;
Specifies the type of constraint.
• property CompilerGenerated as %Boolean;
CompilerGenerated
• property Deferrable as %Boolean [ SqlFieldName = _Deferrable ];
Deferrable
• property Deprecated as %Boolean;
True if this constraint is deprecated.
• property Final as %Boolean;
Final
• property FormalSpec as %RawString;
Specifies the list of arguments that are passed to the constraint.
• property FormalSpecParsed as %RawString;
FormalSpecParsed
• property GeneratedFrom as %RawString;
Specifies the name of the class member from which this constraint is generated, member type depends on the value of the Category keyword.
• property Id as %Integer;
Id
• property InheritedId as %Boolean;
InheritedId
• property Initialmode as %RawString;
Initialmode
• property KeywordError as %Boolean;
KeywordError
• property KeywordModified as %Boolean;
KeywordModified
• relationship Methods as %Dictionary.CompiledConstraintMethod [ Inverse = parent,Cardinality = children ];
Method
• property Name as %Dictionary.Identifier [ Required ];
Name
• property NotInheritable as %Boolean;
NotInheritable
• property Origin as %RawString;
Origin
• property Parameters as array of %RawString;
Parameter
• property SqlName as %RawString;
SqlName
• property Type as %RawString;
Type
• relationship parent as %Dictionary.CompiledClass [ Inverse = Constraints,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, timeout As %Integer) as %Status
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
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
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "") as %Status
This is a Set accessor method for the Deprecated property.
• classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indices

•index (IDKEY on Name) [IdKey];

Triggers

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


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.