%Library.CompiledClass

persistent class %Library.CompiledClass extends %Library.Persistent

SQL Table Name: %Library.CompiledClass

This class represents a specific, compiled class description contained within the Class Dictionary. That is, 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.

Property Inventory (Including Private)

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

Method Inventory (Including Private)

• %DeleteData()
• %Exists()
• %LoadData()
• %SaveData()
• ClassDefinitionGet()
• ClassDefinitionSet()
• ClassInfoClose()
• ClassInfoExecute()
• ClassInfoFetch()
• ExportODL()
• GetClassList()
• GetClassParameter()
• IndexInfoClose()
• IndexInfoExecute()
• IndexInfoFetch()

Copy link to this sectionProperties

Copy link to this section property ClassDefinition as %ClassDefinition (CLASSNAME = 1);

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

Property methods: ClassDefinitionGet(), ClassDefinitionGetObject(), ClassDefinitionGetObjectId(), ClassDefinitionGetSwizzled(), ClassDefinitionIsValid(), ClassDefinitionNewObject(), ClassDefinitionSet(), ClassDefinitionSetObject(), ClassDefinitionSetObjectId(), ClassDefinitionUnSwizzle()

Copy link to this section property ClassType as %RawString;

A string indicating the class type.

Property methods: ClassTypeGet(), ClassTypeIsValid(), ClassTypeSet()

Copy link to this section property Datatype as %RawString;

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

Property methods: DatatypeGet(), DatatypeIsValid(), DatatypeSet()

Copy link to this section property Description as %RawString;

A string containing the description of the class.

Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()

Copy link to this section property Methods as %ListOfPersistentChildObjects (CLASSNAME = 1);

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

Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsValid(), MethodsNewObject(), MethodsSet(), MethodsSetObject(), MethodsSetObjectId(), MethodsUnSwizzle()

Copy link to this section property Name as %RawString;

A string containing the name of the class.

Property methods: NameGet(), NameIsValid(), NameSet()

Copy link to this section property Parameters as %ListOfPersistentChildObjects (CLASSNAME = 1);

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

Property methods: ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersNewObject(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId(), ParametersUnSwizzle()

Copy link to this section property Persistent as %RawString;

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

Property methods: PersistentGet(), PersistentIsValid(), PersistentSet()

Copy link to this section property Properties as %ListOfPersistentChildObjects (CLASSNAME = 1);

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

Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsValid(), PropertiesNewObject(), PropertiesSet(), PropertiesSetObject(), PropertiesSetObjectId(), PropertiesUnSwizzle()

Copy link to this section property Queries as %ListOfPersistentChildObjects (CLASSNAME = 1);

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

Property methods: QueriesGet(), QueriesGetObject(), QueriesGetObjectId(), QueriesGetSwizzled(), QueriesIsValid(), QueriesNewObject(), QueriesSet(), QueriesSetObject(), QueriesSetObjectId(), QueriesUnSwizzle()

Copy link to this section property Serial as %RawString;

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

Property methods: SerialGet(), SerialIsValid(), SerialSet()

Copy link to this section property System as %RawString;

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

Property methods: SystemGet(), SystemIsValid(), SystemSet()

Copy link to this section property list as %ListOfDataTypes [ Transient ];

Property methods: listGet(), listGetObject(), listGetObjectId(), listGetSwizzled(), listIsEmpty(), listIsValid(), listNewObject(), listSet(), listSetObject(), listSetObjectId(), listUnSwizzle()

Copy link to this sectionMethods

Copy link to this section private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]

Inherited description: This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.

Copy link to this section classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]

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.

Copy link to this section private method %LoadData(classname As %String) as %Status [ Language = objectscript ]

Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.

Copy link to this section private method %SaveData(id As %String) as %Status [ Language = objectscript ]

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.

Copy link to this section method ClassDefinitionGet() as %ClassDefinition [ Language = objectscript ]

Copy link to this section private method ClassDefinitionSet(val As %ClassDefinition) as %Status [ Language = objectscript ]

Copy link to this section classmethod ClassInfoClose(QHandle As %Binary) as %Status [ Language = objectscript ]

Copy link to this section classmethod ClassInfoExecute(ByRef QHandle As %Binary, initvalue As %String) as %Status [ Language = objectscript ]

Copy link to this section classmethod ClassInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]

Copy link to this section classmethod ExportODL(Class As %String, File As %String) as %Status [ Language = objectscript ]

Copy link to this section method GetClassList() as %ListOfDataTypes [ Language = objectscript ]

Copy link to this section classmethod GetClassParameter(classname As %String, name As %String) as %String [ Language = objectscript ]

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

Copy link to this section classmethod IndexInfoClose(QHandle As %Binary) as %Status [ Language = objectscript ]

Copy link to this section classmethod IndexInfoExecute(ByRef QHandle As %Binary, classname As %String) as %Status [ Language = objectscript ]

Copy link to this section classmethod IndexInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]

Copy link to this sectionQueries

Copy link to this section 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.

Copy link to this section 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.

Copy link to this sectionIndices

Copy link to this section index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()