Skip to main content


persistent class %Library.CompiledProperty extends %Library.Persistent

SQL Table Name: %Library.CompiledProperty

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific property description for a compiled class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory

Method Inventory


property Calculated as %CacheString;
A flag indicating whether the property is calculated (1) or not (0).
Property methods: CalculatedGet(), CalculatedIsValid(), CalculatedSet()
property ClassName as %CacheString;
A string containing the name of the class the property belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property Collection as %CacheString;
If the property is a collection, this is a string containing the name of the collection type. If the property is not a collection (single-valued) it contains a null string ("").
Property methods: CollectionGet(), CollectionIsValid(), CollectionSet()
property Datatype as %CacheString;
Property methods: DatatypeGet(), DatatypeIsValid(), DatatypeSet()
property InitialExpression as %CacheString;
A string containing the initial value expression for the property.
Property methods: InitialExpressionGet(), InitialExpressionIsValid(), InitialExpressionSet()
property MultiDimensional as %CacheString;
A flag indicating whether the property is multi-dimensional (1) or not (0).
Property methods: MultiDimensionalGet(), MultiDimensionalIsValid(), MultiDimensionalSet()
property Name as %CacheString;
A string containing the name of the property.
Property methods: NameGet(), NameIsValid(), NameSet()
property Parameters as array of %CacheString;
An array containing any parameter definitions for the property. The array keys are the parameter names and the array values are the parameter values.
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Persistent as %CacheString;
Property methods: PersistentGet(), PersistentIsValid(), PersistentSet()
property Private as %CacheString;
A flag indicating whether the property is private (1) or public (0).
Property methods: PrivateGet(), PrivateIsValid(), PrivateSet()
property Required as %CacheString;
A flag indicating whether the property is required (1) or not (0).
Property methods: RequiredGet(), RequiredIsValid(), RequiredSet()
property RuntimeDatatype as %CacheString;
Property methods: RuntimeDatatypeGet(), RuntimeDatatypeIsValid(), RuntimeDatatypeSet()
property RuntimeType as %CacheString;
Property methods: RuntimeTypeGet(), RuntimeTypeIsValid(), RuntimeTypeSet()
property Transient as %CacheString;
A flag indicating whether the property is transient (1) or not (0).
Property methods: TransientGet(), TransientIsValid(), TransientSet()
property Type as %CacheString;
A string containing the defined type (class name) of the field.
Property methods: TypeGet(), TypeIsValid(), TypeSet()


classmethod PropertyInfoClose(QHandle As %Binary) as %Status
classmethod PropertyInfoExecute(ByRef QHandle As %Binary, ClassName As %String) as %Status
classmethod PropertyInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status


query PropertyInfo(ClassName As %String)
Selects Name As %String, Datatype, Type, Collection, Caption, Serial, Editable, MaxLen, Required, Stream
The PropertyInfo query provides a summary of information about properties contained within the specific class ClassName.


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

Inherited Members

Inherited Methods

FeedbackOpens in a new tab