Class Reference
Cache for UNIX 2018.1.2
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

persistent class %Dictionary.CompiledClass extends %Persistent, %Dictionary.CompiledClassQuery

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 97 7 1 2


Summary

Properties
Abstract Ancestry CacheVersion ClassCompileError
ClassDefinitionError ClassType Classes ClientDataType
ClientDataTypeEnum ClientInfo ClientName CompilationSignature
CompileAfter CompileNamespace ConstraintClass Constraints
DdlAllowed DependsOn Deployed Deprecated
Description DisableIncremental Dynamic EmbeddedClass
Extents Final ForeignKeys GeneratedBy
HasCPP Hash Hidden Import
Importall IncludeCode IncludeCodeAll IncludeGenerator
IncludeMGenAll IndexClass Indices Inheritance
InitialValue InstanceVars KeywordError KeywordModified
Language LegacyInstanceContext Manifest MemberSuper
Methods ModificationAuxiliary ModificationLevel Modified
Name NoContext NoExtent OdbcType
OldHash Owner Parameters PrimarySuper
ProcedureBlock Procedures ProjectionClass Projections
Properties PropertyClass Queries QueryClass
RandomSig RoutineCount Routines ServerOnly
SlotCount SoapBindingStyle SoapBodyUse SqlCategory
SqlQualifiedNameQ SqlRoutinePrefix SqlRowIdName SqlRowIdPrivate
SqlSchemaName SqlTableName StorageStrategy Storages
Structure Super System Tables
TimeChanged TimeCreated TriggerClass Triggers
UDLTexts ViewQuery Views XDatas
XMLData

Methods
%AddToSaveSet %AddToSyncSet %BuildIndices %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
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SerializeObject %SetModified %SortBegin %SortEnd
%SyncObjectIn %SyncTransport %UnlockExtent %UnlockId
%ValidateIndices %ValidateObject MemberSummaryClose MemberSummaryExecute
MemberSummaryFetch SummaryClose SummaryExecute SummaryFetch


Parameters

• parameter SQLENABLED = 1;

Properties

• property Abstract as %Boolean;
Specifies that the class cannot have instances; for datatypes, specifies that the class cannot be used as an attribute type.
• property Ancestry as %CacheString;
Ancestry
• property CacheVersion as %CacheString;
The version of Cache this class was compiled on.
• property ClassCompileError as %CacheString;
Status code from this class compile if there is an error
• property ClassDefinitionError as %Boolean;
Set to true if there is a problem serializing the class so the compiler knows not to compile this.
• property ClassType as %CacheString;
Specifies how this class is to be used.
• property Classes as array of %CacheString;
Array of items generated by this class.
• property ClientDataType as %CacheString;
In the case of a datatype class, specifies the type used when exposed via ActiveX or Java. Datatype classes must specify a client datatype.
• property ClientDataTypeEnum as %Integer;
ClientDataTypeEnum
• property ClientInfo as array of %CacheString;
ClientInfo
• property ClientName as %CacheString;
This gives an alternate name for the class if it projected, for example, to Java.
• property CompilationSignature as %CacheString;
CompilationSignature
• property CompileAfter as %CacheString;
Indicates that the class compiler should compile this class after the specified classes.
• property CompileNamespace as %CacheString;
The namespace when this class is compiled, used to help dependency checking.
• property ConstraintClass as %CacheString;
Additional constraint member super classes to inherit.
• relationship Constraints as %Dictionary.CompiledConstraint [ Inverse = parent,Cardinality = children ];
Constraint
• property DdlAllowed as %Boolean;
In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition.
• property DependsOn as %CacheString;
List of classes that this class depends on being runable in order for this class to compile.
• property Deployed as %Integer;
Indicates whether the class has been deployed, that is, disassociated from the source that was used to build it.
• property Deprecated as %Boolean;
True if this class is deprecated.
• property Description as %CacheString;
Specifies a description of the class.
• property DisableIncremental as %Boolean;
Deprecated.
• property Dynamic as %Boolean;
Deprecated.
• property EmbeddedClass as %CacheString;
If specified in a member type class is the name of the class which forms the embedded superclass
• property Extents as array of %CacheString;
Extents
• property Final as %Boolean;
Specifies that the class cannot have subclasses.
• relationship ForeignKeys as %Dictionary.CompiledForeignKey [ Inverse = parent,Cardinality = children ];
ForeignKey
• property GeneratedBy as %CacheString;
If this class is generated by some other component then this is the name of the item that generated this class
• property HasCPP as %CacheString;
True if this class has C++ methods.
• property Hash as %CacheString;
A hash of this class so we can detect when it is changed.
• property Hidden as %Boolean;
Specifies that this class is not typically listed when viewing the contents of the class dictionary.
• property Import as %CacheString;
Supplies a list of class packages to import for this class.
• property Importall as array of %CacheString;
Importall
• property IncludeCode as %CacheString;
Specifies an optional list of Cache include files used when compiling this class.
• property IncludeCodeAll as array of %CacheString;
IncludeCodeAll
• property IncludeGenerator as %CacheString;
Specifies an optional list of Cache include files used when compiling the method generator methods of this class.
• property IncludeMGenAll as array of %CacheString;
IncludeMGenAll
• property IndexClass as %CacheString;
Additional index member super classes to inherit.
• relationship Indices as %Dictionary.CompiledIndex [ Inverse = parent,Cardinality = children ];
Index
• property Inheritance as %CacheString;
Define the inheritance order when using multiple inheritance, if a member exists in multiple superclasses which one will take precedence.
• property InitialValue as %CacheString;
If specified the initial serial value for a new object
• relationship InstanceVars as %Dictionary.CompiledInstanceVar [ Inverse = parent,Cardinality = children ];
InstanceVar
• property KeywordError as %Boolean;
KeywordError
• property KeywordModified as %Boolean;
KeywordModified
• property Language as %CacheString [ SqlFieldName = _Language ];
The default language used to implement methods for this class.
• property LegacyInstanceContext as %Boolean;
If true then pass %this as first argument of all instance methods
• property Manifest as array of %CacheString;
Array of items projected with this class which need to be included in any deployment package we create from this class
• property MemberSuper as %CacheString;
This is the class to inherit if this class is used as a member class in member inheritance
• relationship Methods as %Dictionary.CompiledMethod [ Inverse = parent,Cardinality = children ];
Method
• property ModificationAuxiliary as %CacheString;
Deprecated.
• property ModificationLevel as %Integer;
Deprecated.
• property Modified as %CacheString;
If set to 0 then class is always modified, and so it is always saved.
• property Name as %Dictionary.CacheClassname [ Required ];
The name of the class.
• property NoContext as %Boolean;
NoContext
• property NoExtent as %Boolean;
If TRUE will prevent this class from instantiating a persistent extent.
• property OdbcType as %CacheString;
In the case of a datatype class, specifies the type used when exposed via ODBC or JDBC. Datatype classes must specify an ODBC type.
• property OldHash as %CacheString;
Keep track of old hash values so we can modify a class without marking it as out of date.
• property Owner as %CacheString;
Specifies the owner of the class and its corresponding table. By default, classes and tables are owned by _SYSTEM.
• relationship Parameters as %Dictionary.CompiledParameter [ Inverse = parent,Cardinality = children ];
Parameter
• property PrimarySuper as %CacheString;
PrimarySuper
• property ProcedureBlock as %Boolean;
Specifies that the class uses procedure block for method code.
• property Procedures as array of %CacheString;
Procedures
• property ProjectionClass as %CacheString;
Additional projection member super classes to inherit.
• relationship Projections as %Dictionary.CompiledProjection [ Inverse = parent,Cardinality = children ];
Projection
• relationship Properties as %Dictionary.CompiledProperty [ Inverse = parent,Cardinality = children ];
Property
• property PropertyClass as %CacheString;
Additional property member super classes to inherit.
• relationship Queries as %Dictionary.CompiledQuery [ Inverse = parent,Cardinality = children ];
Query
• property QueryClass as %CacheString;
Additional query member super classes to inherit.
• property RandomSig as %CacheString;
Random value that is updated each time the class is compiled
• property RoutineCount as %Integer;
RoutineCount
• property Routines as array of %CacheString;
Routines
• property ServerOnly as %CacheString;
ServerOnly
• property SlotCount as %Integer;
SlotCount
• property SoapBindingStyle as %CacheString;
Specifies the SOAP Binding used by this class when it is used to send and receive mnessages via SOAP.
• property SoapBodyUse as %CacheString;
Specifies the encoding used for SOAP messages.
• property SqlCategory as %CacheString;
In the case of a datatype class, specifies a type to use for calculations in SQL. Datatype classes must specify an SQL Category.
• property SqlQualifiedNameQ as %CacheString;
SqlQualifiedNameQ
• property SqlRoutinePrefix as %CacheString;
Deprecated.
• property SqlRowIdName as %CacheString;
In the case of a persistent class, specifies an altername field name used for the ID column. By default the ID is called ID.
• property SqlRowIdPrivate as %Boolean;
In the case of a persistent class, specifies whether the ID column is projected to ODBC as a hidden field.
• property SqlSchemaName as %CacheString;
SqlSchemaName
• property SqlTableName as %CacheString;
In the case of a persistent class, specifies the table name used to identify the class in its SQL projection. By default, the SQL table name is the same as the class name.
• property StorageStrategy as %CacheString;
Specifies the name of the storage strategy used to control persistence for this class.
• relationship Storages as %Dictionary.CompiledStorage [ Inverse = parent,Cardinality = children ];
Storage
• property Structure as %CacheString;
Hash of class 'structure' so we can detect when SQL related classes need to be recompiled.
• property Super as %CacheString;
Specifies one or more superclasses for the class.
• property System as %CacheString;
Specifies that the class is internal to the implementation of Cache. Users should not mark their classes with this keyword.
• property Tables as array of %CacheString;
Tables
• property TimeChanged as %CacheString;
Gives the time the last change was made to the class.
• property TimeCreated as %CacheString;
Gives the time the class was first created.
• property TriggerClass as %CacheString;
Additional trigger member super classes to inherit.
• relationship Triggers as %Dictionary.CompiledTrigger [ Inverse = parent,Cardinality = children ];
Trigger
• relationship UDLTexts as %Dictionary.CompiledUDLText [ Inverse = parent,Cardinality = children ];
UDLText
• property ViewQuery as %CacheString;
Gives the SQL query used for View definition of this class.
• property Views as array of %CacheString;
Views
• relationship XDatas as %Dictionary.CompiledXData [ Inverse = parent,Cardinality = children ];
XData
• property XMLData as array of %CacheString;
XMLData

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.

• classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
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.
• classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
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.

Indices

• index (IDKEY on Name) [IdKey];

Triggers

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


Copyright © 1997-2019, InterSystems Corporation