Class %Library.CompiledClass

deprecatedpersistent class %Library.CompiledClass extends %Persistent

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

This class represents a specific, compiled class definition. It contains all class members, including those that are inherited from super classes.

Instances of this class are "read only"; to modify class definitions use the non-compiled class definition classes.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	13	15	2

Summary

Properties
ClassDefinition	ClassType	Datatype	Description
Methods	Name	Parameters	Persistent
Properties	Queries	Serial	System
list

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	ClassDefinitionGet	ClassInfoClose	ClassInfoExecute
ClassInfoFetch	ExportODL	GetClassList	GetClassParameter
IndexInfoClose	IndexInfoExecute	IndexInfoFetch

Properties

• property ClassDefinition as %ClassDefinition(CLASSNAME=1);

Returns a %ClassDefinition for this class so that you can edit the class definition.

• property ClassType as %RawString;

A string indicating the class type.

• property Datatype as %RawString;

A flag indicating whether the class is a datatype class (1) or not (0).

• property Description as %RawString;

A string containing the description of the class.

• property Methods as %ListOfPersistentChildObjects(CLASSNAME=1);

A collection of methods belonging to the class. See %CompiledMethod for details.

• property Name as %RawString;

A string containing the name of the class.

• property Parameters as %ListOfPersistentChildObjects(CLASSNAME=1);

A collection of class parameters belonging to the class. See %CompiledParameter for details.

• property Persistent as %RawString;

A flag indicating whether the class is persistent (1) or not (0).

• property Properties as %ListOfPersistentChildObjects(CLASSNAME=1);

A collection of properties belonging to the class. See %CompiledProperty for details.

• property Queries as %ListOfPersistentChildObjects(CLASSNAME=1);

A collection of queries belonging to the class. See %CompiledQuery for details.

• property Serial as %RawString;

A flag indicating whether the class is serial (embeddable) (1) or not (0).

• property System as %RawString;

A flag indicating whether the class is a system class (1) or not (0).

• property list as %ListOfDataTypes [ Transient ];

Methods

• classmethod %Exists(oid As %ObjectIdentity) as %Boolean

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.

• method ClassDefinitionGet() as %ClassDefinition

This is a Get accessor method for the ClassDefinition property.

• classmethod ClassInfoClose(QHandle As %Binary) as %Status

• classmethod ClassInfoExecute(ByRef QHandle As %Binary, initvalue As %String) as %Status

• classmethod ClassInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

• classmethod ExportODL(Class As %String, File As %String) as %Status

• method GetClassList() as %ListOfDataTypes

• classmethod GetClassParameter(classname As %String, name As %String) as %String

The GetParameter method returns the value of the parameter named name from the class classname.

• classmethod IndexInfoClose(QHandle As %Binary) as %Status

• classmethod IndexInfoExecute(ByRef QHandle As %Binary, classname As %String) as %Status

• classmethod IndexInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

• query ClassInfo(initvalue As %String)

Selects Name, Abstract As %Integer, System, Persistent, HasProperty As %Integer, Caption

The ClassInfo query provides a summary of information about compiled classes contained in the Class Dictionary.

• query IndexInfo(classname As %String)

Selects Name As %String, Attributes As %String, Type As %String, PrimaryKey As %Integer, Unique As %Integer

The IndexInfo query provides a list of indices defined for the class classname.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search