Skip to main content

%Dictionary.PropertyDefinition

Class %Dictionary.PropertyDefinition Extends (%Persistent, %Dictionary.PropertyDefinitionQuery) [ StorageStrategy = custom, System = 2 ]

Parameters​

SQLENABLED​

Parameter SQLENABLED = 1;

Properties​

parent​

Relationship parent As %Dictionary.ClassDefinition [ Cardinality = parent, Inverse = Properties ];

Pointer to the containing parent object

%isDefined​

Property %isDefined As %RawString [ MultiDimensional, Private, Transient ];

Stores the DEFINED state of each attribute.

Aliases​

Property Aliases As %RawString;

List of aliases for this property.

Calculated​

Property Calculated As %Boolean [ InitialExpression = 0 ];

Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.

Cardinality​

Property Cardinality As %RawString;

Specifies the cardinality of a relationship property. The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.

ClientName​

Property ClientName As %RawString;

An alias used by client projections of this property.

Collection​

Property Collection As %RawString;

Specifies that a property is a collection property as well as what type of collection it is.

Deprecated​

Property Deprecated As %Boolean [ InitialExpression = 0 ];

True if this property is deprecated.

Description​

Property Description As %RawString;

Specifies a description of the property.

Final​

Property Final As %Boolean [ InitialExpression = 0 ];

Specifies that subclasses cannot override the definition of this property.

Identity​

Property Identity As %Boolean [ InitialExpression = 0, SqlFieldName = _Identity ];

Specifies that this property is the identity for this class. Identity properties can be set in new objects only and the default is set by incrementing a counter.

InitialExpression​

Property InitialExpression As %RawString [ InitialExpression = """""" ];

Specifies an initial value for the property.

Internal​

Property Internal As %Boolean [ InitialExpression = 0 ];

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

Inverse​

Property Inverse As %RawString;

Specifies the name of the inverse side of a relationship. That is, the name of the corresponding relationship property in the related class. The inverse property must exist in the related class and have the correct Cardinality value. The Inverse keyword is required for relationship properties. It is ignored by non-relationship properties.

MultiDimensional​

Property MultiDimensional As %Boolean [ InitialExpression = 0 ];

Specifies that an attribute has the characteristics of a multidimensional array.

Name​

Property Name As %Dictionary.Identifier [ Required ];

The name of the property.

NoModBit​

Property NoModBit As %Boolean [ InitialExpression = 0 ];

Deprecated.

NotInheritable​

Property NotInheritable As %Boolean [ InitialExpression = 0 ];

Deprecated.

OnDelete​

Property OnDelete As %RawString;

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

Parameters​

Property Parameters As array Of %RawString;

Parameter

Private​

Property Private As %Boolean [ InitialExpression = 0 ];

Specifies that the property is private. Private properties can only be used by instance methods of this class or its subclasses.

ReadOnly​

Property ReadOnly As %Boolean [ InitialExpression = 0 ];

Specifies that the property is readonly.

Relationship​

Property Relationship As %Boolean [ InitialExpression = 0 ];

Specifies that a property is a relationship property.

Required​

Property Required As %Boolean [ InitialExpression = 0 ];

In the case of a persistent class, specifies that the value of the property must be given a value before it can be stored to disk.

SequenceNumber​

Property SequenceNumber As %Integer [ InitialExpression = 0 ];

SequenceNumber

ServerOnly​

Property ServerOnly As %RawString;

Specifies that a property will not be projected to a Java or C++ client.

SqlCollation​

Property SqlCollation As %RawString;

Deprecated.

SqlColumnNumber​

Property SqlColumnNumber As %RawString;

Explicitly sets the SQL Column number for this property. This is provided for legacy application support.

SqlComputeCode​

Property SqlComputeCode As %RawString;

Specifies ObjectScript code that evaluates to a computed field value.

SqlComputed​

Property SqlComputed As %Boolean [ InitialExpression = 0 ];

Specifies that this property is an SQL computed field.

SqlComputeOnChange​

Property SqlComputeOnChange As %RawString;

Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL.

SqlFieldName​

Property SqlFieldName As %RawString;

In the case of a persistent class, specifies the column name used to identify the property in its SQL projection. By default, the SQL column name is the same as the property name.

SqlListDelimiter​

Property SqlListDelimiter As %RawString;

Specifies the delimiter character used within SQL for lists. This is provided for legacy application support.

SqlListType​

Property SqlListType As %RawString;

specifies the representation to be used for a list.

Transient​

Property Transient As %Boolean [ InitialExpression = 0 ];

In the case of a persistent class, specifies that the property is not stored in the database.

Type​

Property Type As %Dictionary.Classname;

Specifies the name of the class associated with the property, which can be a data type class, a persistent class, or an embeddable serial class.

UDLTexts​

Relationship UDLTexts As %Dictionary.PropertyUDLTextDefinition [ Cardinality = children, Inverse = parent ];

UDLText

Triggers​

OnInsertUpdate​

Trigger OnInsertUpdate [ Event = INSERT/UPDATE ]

OnDelete​

Trigger OnDelete [ Event = DELETE, Time = AFTER ]

Methods​

CardinalityIsValid​

ClassMethod CardinalityIsValid(val As %String) As %Status

CollectionIsValid​

ClassMethod CollectionIsValid(val As %String) As %Status

OnDeleteIsValid​

ClassMethod OnDeleteIsValid(val As %String) As %Status

ServerOnlyIsValid​

ClassMethod ServerOnlyIsValid(val As %String) As %Status

SqlCollationIsValid​

ClassMethod SqlCollationIsValid(val As %String) As %Status

SqlListTypeIsValid​

ClassMethod SqlListTypeIsValid(val As %String) As %Status

%OnNew​

Method %OnNew(name As %String) As %Status [ Private ]

%LockId​

ClassMethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) As %Status

%UnlockId​

ClassMethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) As %Status

%Exists​

ClassMethod %Exists(oid As %ObjectIdentity) As %Boolean

%LoadData​

Method %LoadData(id As %String) As %Status [ Private ]

%SaveData​

Method %SaveData(id As %String) As %Status [ Private ]

%DeleteData​

ClassMethod %DeleteData(id As %String, concurrency As %Integer) As %Status [ Private ]

AliasesSet​

Method AliasesSet(value As %String = "") As %Status

AliasesReset​

Method AliasesReset()

AliasesIsDefined​

Method AliasesIsDefined() As %Boolean

CalculatedSet​

Method CalculatedSet(value As %String = "") As %Status

CalculatedReset​

Method CalculatedReset()

CalculatedIsDefined​

Method CalculatedIsDefined() As %Boolean

CardinalitySet​

Method CardinalitySet(value As %String = "") As %Status

CardinalityReset​

Method CardinalityReset()

CardinalityIsDefined​

Method CardinalityIsDefined() As %Boolean

ClientNameSet​

Method ClientNameSet(value As %String = "") As %Status

ClientNameReset​

Method ClientNameReset()

ClientNameIsDefined​

Method ClientNameIsDefined() As %Boolean

CollectionSet​

Method CollectionSet(value As %String = "") As %Status

CollectionReset​

Method CollectionReset()

CollectionIsDefined​

Method CollectionIsDefined() As %Boolean

DeprecatedSet​

Method DeprecatedSet(value As %String = "") As %Status

DeprecatedReset​

Method DeprecatedReset()

DeprecatedIsDefined​

Method DeprecatedIsDefined() As %Boolean

DescriptionSet​

Method DescriptionSet(value As %String = "") As %Status

DescriptionReset​

Method DescriptionReset()

DescriptionIsDefined​

Method DescriptionIsDefined() As %Boolean

FinalSet​

Method FinalSet(value As %String = "") As %Status

FinalReset​

Method FinalReset()

FinalIsDefined​

Method FinalIsDefined() As %Boolean

IdentitySet​

Method IdentitySet(value As %String = "") As %Status

IdentityReset​

Method IdentityReset()

IdentityIsDefined​

Method IdentityIsDefined() As %Boolean

InitialExpressionSet​

Method InitialExpressionSet(value As %String = "") As %Status

InitialExpressionReset​

Method InitialExpressionReset()

InitialExpressionIsDefined​

Method InitialExpressionIsDefined() As %Boolean

InternalSet​

Method InternalSet(value As %String = "") As %Status

InternalReset​

Method InternalReset()

InternalIsDefined​

Method InternalIsDefined() As %Boolean

InverseSet​

Method InverseSet(value As %String = "") As %Status

InverseReset​

Method InverseReset()

InverseIsDefined​

Method InverseIsDefined() As %Boolean

MultiDimensionalSet​

Method MultiDimensionalSet(value As %String = "") As %Status

MultiDimensionalReset​

Method MultiDimensionalReset()

MultiDimensionalIsDefined​

Method MultiDimensionalIsDefined() As %Boolean

NameSet​

Method NameSet(value As %String = "") As %Status

NameReset​

Method NameReset()

NameIsDefined​

Method NameIsDefined() As %Boolean

NoModBitSet​

Method NoModBitSet(value As %String = "") As %Status

NoModBitReset​

Method NoModBitReset()

NoModBitIsDefined​

Method NoModBitIsDefined() As %Boolean

NotInheritableSet​

Method NotInheritableSet(value As %String = "") As %Status

NotInheritableReset​

Method NotInheritableReset()

NotInheritableIsDefined​

Method NotInheritableIsDefined() As %Boolean

OnDeleteSet​

Method OnDeleteSet(value As %String = "") As %Status

OnDeleteReset​

Method OnDeleteReset()

OnDeleteIsDefined​

Method OnDeleteIsDefined() As %Boolean

PrivateSet​

Method PrivateSet(value As %String = "") As %Status

PrivateReset​

Method PrivateReset()

PrivateIsDefined​

Method PrivateIsDefined() As %Boolean

ReadOnlySet​

Method ReadOnlySet(value As %String = "") As %Status

ReadOnlyReset​

Method ReadOnlyReset()

ReadOnlyIsDefined​

Method ReadOnlyIsDefined() As %Boolean

RelationshipSet​

Method RelationshipSet(value As %String = "") As %Status

RelationshipReset​

Method RelationshipReset()

RelationshipIsDefined​

Method RelationshipIsDefined() As %Boolean

RequiredSet​

Method RequiredSet(value As %String = "") As %Status

RequiredReset​

Method RequiredReset()

RequiredIsDefined​

Method RequiredIsDefined() As %Boolean

SequenceNumberSet​

Method SequenceNumberSet(value As %String = "") As %Status

SequenceNumberReset​

Method SequenceNumberReset()

SequenceNumberIsDefined​

Method SequenceNumberIsDefined() As %Boolean

ServerOnlySet​

Method ServerOnlySet(value As %String = "") As %Status

ServerOnlyReset​

Method ServerOnlyReset()

ServerOnlyIsDefined​

Method ServerOnlyIsDefined() As %Boolean

SqlCollationSet​

Method SqlCollationSet(value As %String = "") As %Status

SqlCollationReset​

Method SqlCollationReset()

SqlCollationIsDefined​

Method SqlCollationIsDefined() As %Boolean

SqlColumnNumberSet​

Method SqlColumnNumberSet(value As %String = "") As %Status

SqlColumnNumberReset​

Method SqlColumnNumberReset()

SqlColumnNumberIsDefined​

Method SqlColumnNumberIsDefined() As %Boolean

SqlComputeCodeSet​

Method SqlComputeCodeSet(value As %String = "") As %Status

SqlComputeCodeReset​

Method SqlComputeCodeReset()

SqlComputeCodeIsDefined​

Method SqlComputeCodeIsDefined() As %Boolean

SqlComputedSet​

Method SqlComputedSet(value As %String = "") As %Status

SqlComputedReset​

Method SqlComputedReset()

SqlComputedIsDefined​

Method SqlComputedIsDefined() As %Boolean

SqlComputeOnChangeSet​

Method SqlComputeOnChangeSet(value As %String = "") As %Status

SqlComputeOnChangeReset​

Method SqlComputeOnChangeReset()

SqlComputeOnChangeIsDefined​

Method SqlComputeOnChangeIsDefined() As %Boolean

SqlFieldNameSet​

Method SqlFieldNameSet(value As %String = "") As %Status

SqlFieldNameReset​

Method SqlFieldNameReset()

SqlFieldNameIsDefined​

Method SqlFieldNameIsDefined() As %Boolean

SqlListDelimiterSet​

Method SqlListDelimiterSet(value As %String = "") As %Status

SqlListDelimiterReset​

Method SqlListDelimiterReset()

SqlListDelimiterIsDefined​

Method SqlListDelimiterIsDefined() As %Boolean

SqlListTypeSet​

Method SqlListTypeSet(value As %String = "") As %Status

SqlListTypeReset​

Method SqlListTypeReset()

SqlListTypeIsDefined​

Method SqlListTypeIsDefined() As %Boolean

TransientSet​

Method TransientSet(value As %String = "") As %Status

TransientReset​

Method TransientReset()

TransientIsDefined​

Method TransientIsDefined() As %Boolean

TypeSet​

Method TypeSet(value As %String = "") As %Status

TypeReset​

Method TypeReset()

TypeIsDefined​

Method TypeIsDefined() As %Boolean

parentOnDelete​

ClassMethod parentOnDelete(id As %String, concurrency As %Integer) As %Status