Skip to main content

%Dictionary.CompiledConstraint

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

SQL Table Name: %Dictionary.CompiledConstraint

Property Inventory

Method Inventory

Parameters

parameter SQLENABLED = 1;

Properties

property Category as %RawString;
Specifies the type of constraint.
Property methods: CategoryGet(), CategoryIsValid(), CategorySet()
property CompilerGenerated as %Boolean;
CompilerGenerated
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Deferrable as %Boolean [ SqlFieldName = _Deferrable ];
Deferrable
Property methods: DeferrableDisplayToLogical(), DeferrableGet(), DeferrableIsValid(), DeferrableLogicalToDisplay(), DeferrableNormalize(), DeferrableSet()
property Deprecated as %Boolean;
True if this constraint is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize()
property Final as %Boolean;
Final
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property FormalSpec as %RawString;
Specifies the list of arguments that are passed to the constraint.
Property methods: FormalSpecGet(), FormalSpecIsValid(), FormalSpecSet()
property FormalSpecParsed as %RawString;
FormalSpecParsed
Property methods: FormalSpecParsedGet(), FormalSpecParsedIsValid(), FormalSpecParsedSet()
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 methods: GeneratedFromGet(), GeneratedFromIsValid(), GeneratedFromSet()
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 Initialmode as %RawString;
Initialmode
Property methods: InitialmodeGet(), InitialmodeIsValid(), InitialmodeSet()
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()
relationship Methods as array of %Dictionary.CompiledConstraintMethod [ InitialExpression = $listbuild("%Dictionary.CompiledConstraintMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Method
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property Name as %Dictionary.Identifier [ Required ];
Name
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean;
NotInheritable
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Origin as %RawString;
Origin
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %RawString;
Parameter
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property SqlName as %RawString;
SqlName
Property methods: SqlNameGet(), SqlNameIsValid(), SqlNameSet()
property Type as %RawString;
Type
Property methods: TypeGet(), TypeIsValid(), TypeSet()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Constraints , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()

Methods

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.

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 %Storage.Persistent or %Storage.SQL.
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 %Storage.Persistent or %Storage.SQL.
method DeprecatedIsDefined() as %Boolean
method DeprecatedReset()
method DeprecatedSet(value As %String = "") as %Status
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

FeedbackOpens in a new tab