Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Library] >  [CompiledProperty]
Private  Storage   

deprecatedpersistent class %Library.CompiledProperty extends %Persistent

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

This class represents a specific property description for a compiled class.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15 6 1


Summary

Properties
Calculated ClassName Collection Datatype
InitialExpression MultiDimensional Name Parameters
Persistent Private Required RuntimeDatatype
RuntimeType Transient Type

Methods
%AddToSaveSet %AddToSyncSet %BuildDeferredIndices %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %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 %OnDeleteFinally
%OnDetermineClass %OnOpenFinally %OnSaveFinally %Open
%OpenId %OriginalNamespace %PackageName %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %ValidateIndices %ValidateObject
%ValidateTable PropertyInfoClose PropertyInfoExecute PropertyInfoFetch


Properties

• property Calculated as %RawString;
A flag indicating whether the property is calculated (1) or not (0).
• property ClassName as %RawString;
A string containing the name of the class the property belongs to.
• property Collection as %RawString;
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 Datatype as %RawString;
• property InitialExpression as %RawString;
A string containing the initial value expression for the property.
• property MultiDimensional as %RawString;
A flag indicating whether the property is multi-dimensional (1) or not (0).
• property Name as %RawString;
A string containing the name of the property.
• property Parameters as array of %RawString;
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 Persistent as %RawString;
• property Private as %RawString;
A flag indicating whether the property is private (1) or public (0).
• property Required as %RawString;
A flag indicating whether the property is required (1) or not (0).
• property RuntimeDatatype as %RawString;
• property RuntimeType as %RawString;
• property Transient as %RawString;
A flag indicating whether the property is transient (1) or not (0).
• property Type as %RawString;
A string containing the defined type (class name) of the field.

Methods

• 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

Queries

• 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.


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