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 > %SYS namespace > %Dictionary.CompiledProperty


persistent class %Dictionary.CompiledProperty extends %Library.Persistent, %Dictionary.CompiledPropertyQuery

SQL Table Name: %Dictionary.CompiledProperty

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter SQLENABLED = 1;

Properties (Including Private)

property Aliases as %CacheString;
List of aliases for this property.
Property methods: AliasesGet(), AliasesIsValid(), AliasesSet()
property Calculated as %Boolean;
Specifies that the property has no in-memory storage allocated for it when the object containing it is instantiated.
Property methods: CalculatedDisplayToLogical(), CalculatedGet(), CalculatedIsValid(), CalculatedLogicalToDisplay(), CalculatedNormalize(), CalculatedSet()
property Cardinality as %CacheString;
Specifies the cardinality of a relationship property. The Cardinality keyword is required for relationship properties. It is ignored by non-relationship properties.
Property methods: CardinalityGet(), CardinalityIsValid(), CardinalitySet()
property ClientName as %CacheString;
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Collection as %CacheString;
Specifies that a property is a collection property as well as what type of collection it is.
Property methods: CollectionGet(), CollectionIsValid(), CollectionSet()
property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property ComputeDependency as %CacheString;
List of properties referenced by the SQLCOMPUTECODE.
Property methods: ComputeDependencyGet(), ComputeDependencyIsValid(), ComputeDependencySet()
property ComputeTriggers as %CacheString;
List of properties to be computed when this property changes.
Property methods: ComputeTriggersGet(), ComputeTriggersIsValid(), ComputeTriggersSet()
property Deprecated as %Boolean;
True if this property is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the property.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property DirectRefOnGet as %Boolean;
Property methods: DirectRefOnGetDisplayToLogical(), DirectRefOnGetGet(), DirectRefOnGetIsValid(), DirectRefOnGetLogicalToDisplay(), DirectRefOnGetNormalize(), DirectRefOnGetSet()
property DirectRefOnSet as %Boolean;
Property methods: DirectRefOnSetDisplayToLogical(), DirectRefOnSetGet(), DirectRefOnSetIsValid(), DirectRefOnSetLogicalToDisplay(), DirectRefOnSetNormalize(), DirectRefOnSetSet()
property Final as %Boolean;
Specifies that subclasses cannot override the definition of this property.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property Id as %Integer;
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet(), IdentityDisplayToLogical(), IdentityGet(), IdentityIsValid(), IdentityLogicalToDisplay(), IdentityNormalize(), IdentitySet()
property Identity as %Boolean [ 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.
Property methods: IdentityDisplayToLogical(), IdentityGet(), IdentityIsValid(), IdentityLogicalToDisplay(), IdentityNormalize(), IdentitySet()
property InheritedId as %Boolean;
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property InitialExpression as %CacheString;
Specifies an initial value for the property.
Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()
property Internal as %Boolean;
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property Inverse as %CacheString;
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.
Property methods: InverseGet(), InverseIsValid(), InverseSet()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
relationship Methods as array of %Dictionary.CompiledPropertyMethod [ InitialExpression = $listbuild("%Dictionary.CompiledPropertyMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property MultiDimensional as %Boolean;
Specifies that an attribute has the characteristics of a multidimensional array.
Property methods: MultiDimensionalDisplayToLogical(), MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalLogicalToDisplay(), MultiDimensionalNormalize(), MultiDimensionalSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the property.
Property methods: NameGet(), NameIsValid(), NameSet()
property NoModBit as %Boolean;
Property methods: NoModBitDisplayToLogical(), NoModBitGet(), NoModBitIsValid(), NoModBitLogicalToDisplay(), NoModBitNormalize(), NoModBitSet()
property NotInheritable as %Boolean;
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 Origin as %CacheString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %CacheString;
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %Boolean;
Specifies that the property is private. Private properties can only be used by instance methods of this class or its subclasses.
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateSet()
property ReadOnly as %Boolean;
Specifies that the property is readonly.
Property methods: ReadOnlyDisplayToLogical(), ReadOnlyGet(), ReadOnlyIsValid(), ReadOnlyLogicalToDisplay(), ReadOnlyNormalize(), ReadOnlySet()
property Relationship as %Boolean;
Specifies that a property is a relationship property.
Property methods: RelationshipDisplayToLogical(), RelationshipGet(), RelationshipIsValid(), RelationshipLogicalToDisplay(), RelationshipNormalize(), RelationshipSet()
property Required as %Boolean;
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.
Property methods: RequiredDisplayToLogical(), RequiredGet(), RequiredIsValid(), RequiredLogicalToDisplay(), RequiredNormalize(), RequiredSet()
property RuntimeType as %CacheString;
Property methods: RuntimeTypeGet(), RuntimeTypeIsValid(), RuntimeTypeSet()
property SequenceNumber as %Integer;
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property ServerOnly as %CacheString;
Specifies that a property will not be projected to a Java or C++ client.
Property methods: ServerOnlyGet(), ServerOnlyIsValid(), ServerOnlySet()
property SqlCollation as %CacheString;
Property methods: SqlCollationGet(), SqlCollationIsValid(), SqlCollationSet()
property SqlColumnNumber as %CacheString;
Explicitly sets the SQL Column number for this property. This is provided for legacy application support.
Property methods: SqlColumnNumberGet(), SqlColumnNumberIsValid(), SqlColumnNumberSet()
property SqlComputeCode as %CacheString;
Specifies Cache ObjectScript code that evaluates to a computed field value.
Property methods: SqlComputeCodeGet(), SqlComputeCodeIsValid(), SqlComputeCodeSet()
property SqlComputeOnChange as %CacheString;
Specifies one or more properties whose modification triggers the recalculation of this computed field within SQL.
Property methods: SqlComputeOnChangeGet(), SqlComputeOnChangeIsValid(), SqlComputeOnChangeSet()
property SqlComputed as %Boolean;
Specifies that this property is an SQL computed field.
Property methods: SqlComputedDisplayToLogical(), SqlComputedGet(), SqlComputedIsValid(), SqlComputedLogicalToDisplay(), SqlComputedNormalize(), SqlComputedSet()
property SqlFieldName as %CacheString;
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.
Property methods: SqlFieldNameGet(), SqlFieldNameIsValid(), SqlFieldNameSet()
property SqlListDelimiter as %CacheString;
Specifies the delimiter character used within SQL for lists. This is provided for legacy application support.
Property methods: SqlListDelimiterGet(), SqlListDelimiterIsValid(), SqlListDelimiterSet()
property SqlListType as %CacheString;
specifies the representation to be used for a list.
Property methods: SqlListTypeGet(), SqlListTypeIsValid(), SqlListTypeSet()
property Storable as %Boolean;
Property methods: StorableDisplayToLogical(), StorableGet(), StorableIsValid(), StorableLogicalToDisplay(), StorableNormalize(), StorableSet()
property Transient as %Boolean;
In the case of a persistent class, specifies that the property is not stored in the database.
Property methods: TransientDisplayToLogical(), TransientGet(), TransientIsValid(), TransientLogicalToDisplay(), TransientNormalize(), TransientSet()
property Type as %Dictionary.CacheClassname;
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.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
relationship UDLTexts as array of %Dictionary.CompiledPropertyUDLText [ InitialExpression = $listbuild("%Dictionary.CompiledPropertyUDLText","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: UDLTextsGet(), UDLTextsGetObject(), UDLTextsGetObjectId(), UDLTextsGetSwizzled(), UDLTextsIsEmpty(), UDLTextsIsValid(), UDLTextsNewObject(), UDLTextsRClose(), UDLTextsRExec(), UDLTextsRFetch(), UDLTextsRelate(), UDLTextsSQLCompute(), UDLTextsSet(), UDLTextsUnRelate()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Properties , 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


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


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

Inherited Members

Inherited Methods (Including Private)