Skip to main content

%Dictionary.ClassDefinition

Class %Dictionary.ClassDefinition Extends (%Persistent, %Dictionary.ClassDefinitionQuery) [ StorageStrategy = custom, System = 2 ]

Parameters​

SQLENABLED​

Parameter SQLENABLED = 1;

Properties​

%isDefined​

Property %isDefined As %RawString [ MultiDimensional, Private, Transient ];

Stores the DEFINED state of each attribute.

ClassVersion​

Property ClassVersion As %Integer [ InitialExpression = 23, Transient ];

The class dictionary version to define new classes with, defaults to 23. If you set it to 25 or more for a new class it will also use ProcedureBlocks as well unless you have manually changed the ProcedureBlock setting.

Abstract​

Property Abstract As %Boolean [ InitialExpression = 0 ];

Specifies that the class cannot have instances; for datatypes, specifies that the class cannot be used as an attribute type.

ClassDefinitionError​

Property ClassDefinitionError As %Boolean [ InitialExpression = 0 ];

Set to true if there is a problem serializing the class so the compiler knows not to compile this.

ClassType​

Property ClassType As %RawString;

Specifies how this class is to be used.

ClientDataType​

Property ClientDataType As %RawString [ InitialExpression = "VARCHAR" ];

In the case of a datatype class, specifies the type used when exposed via ActiveX or Java. Datatype classes must specify a client datatype.

ClientName​

Property ClientName As %RawString;

This gives an alternate name for the class if it projected, for example, to Java.

CompileAfter​

Property CompileAfter As %RawString;

Indicates that the class compiler should compile this class after the specified classes.

ConstraintClass​

Property ConstraintClass As %RawString;

Additional constraint member super classes to inherit.

Property Copyright As %RawString;

Optional copyright notice associated with this class

DdlAllowed​

Property DdlAllowed As %Boolean [ InitialExpression = 0 ];

In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition.

DependsOn​

Property DependsOn As %RawString;

List of classes that this class depends on being runable in order for this class to compile.

Deployed​

Property Deployed As %Integer [ InitialExpression = 0 ];

Indicates whether the class has been deployed, that is, disassociated from the source that was used to build it.

Deprecated​

Property Deprecated As %Boolean [ InitialExpression = 0 ];

True if this class is deprecated.

Description​

Property Description As %RawString;

Specifies a description of the class.

Dynamic​

Property Dynamic As %Boolean [ InitialExpression = 0 ];

Deprecated.

EmbeddedClass​

Property EmbeddedClass As %RawString;

If specified in a member type class is the name of the class which forms the embedded superclass

Final​

Property Final As %Boolean [ InitialExpression = 0 ];

Specifies that the class cannot have subclasses.

ForeignKeys​

Relationship ForeignKeys As %Dictionary.ForeignKeyDefinition [ Cardinality = children, Inverse = parent ];

ForeignKey

GeneratedBy​

Property GeneratedBy As %RawString;

If this class is generated by some other component then this is the name of the item that generated this class

Hidden​

Property Hidden As %Boolean [ InitialExpression = 0 ];

Specifies that this class is not typically listed when viewing the contents of the class dictionary.

Import​

Property Import As %RawString;

Supplies a list of class packages to import for this class.

IncludeCode​

Property IncludeCode As %RawString;

Specifies an optional list of include files used when compiling this class.

IncludeGenerator​

Property IncludeGenerator As %RawString;

Specifies an optional list of include files used when compiling the method generator methods of this class.

Indices​

Relationship Indices As %Dictionary.IndexDefinition [ Cardinality = children, Inverse = parent ];

Index

IndexClass​

Property IndexClass As %RawString;

Additional index member super classes to inherit.

Inheritance​

Property Inheritance As %RawString [ InitialExpression = "left" ];

Define the inheritance order when using multiple inheritance, if a member exists in multiple superclasses which one will take precedence.

Language​

Property Language As %RawString [ InitialExpression = "objectscript", SqlFieldName = _Language ];

The default language used to implement methods for this class.

LegacyInstanceContext​

Property LegacyInstanceContext As %Boolean [ InitialExpression = 0 ];

If true then pass %this as first argument of all instance methods

MemberSuper​

Property MemberSuper As %RawString;

This is the class to inherit if this class is used as a member class in member inheritance

Methods​

Relationship Methods As %Dictionary.MethodDefinition [ Cardinality = children, Inverse = parent ];

Method

ModificationAuxiliary​

Property ModificationAuxiliary As %RawString;

Deprecated.

ModificationLevel​

Property ModificationLevel As %Integer [ InitialExpression = 9 ];

Deprecated.

Modified​

Property Modified As %RawString [ InitialExpression = 3 ];

If set to 0 then class is always modified, and so it is always saved.

Name​

Property Name As %Dictionary.Classname [ Required ];

The name of the class.

NoContext​

Property NoContext As %Boolean [ InitialExpression = 0 ];

If true, datatype methods have access to the current instance instead of providing their own context.

NoExtent​

Property NoExtent As %Boolean [ InitialExpression = 0 ];

If TRUE will prevent this class from instantiating a persistent extent.

OdbcType​

Property OdbcType As %RawString [ InitialExpression = "VARCHAR" ];

In the case of a datatype class, specifies the type used when exposed via ODBC or JDBC. Datatype classes must specify an ODBC type.

Owner​

Property Owner As %RawString;

Specifies the owner of the class and its corresponding table. By default, classes and tables are owned by _SYSTEM.

Parameters​

Relationship Parameters As %Dictionary.ParameterDefinition [ Cardinality = children, Inverse = parent ];

Parameter

ProcedureBlock​

Property ProcedureBlock As %Boolean [ InitialExpression = 0 ];

Specifies that the class uses procedure block for method code.

Projections​

Relationship Projections As %Dictionary.ProjectionDefinition [ Cardinality = children, Inverse = parent ];

Projection

ProjectionClass​

Property ProjectionClass As %RawString;

Additional projection member super classes to inherit.

Properties​

Relationship Properties As %Dictionary.PropertyDefinition [ Cardinality = children, Inverse = parent ];

Property

PropertyClass​

Property PropertyClass As %RawString;

Additional property member super classes to inherit.

Queries​

Relationship Queries As %Dictionary.QueryDefinition [ Cardinality = children, Inverse = parent ];

Query

QueryClass​

Property QueryClass As %RawString;

Additional query member super classes to inherit.

ServerOnly​

Property ServerOnly As %RawString;

Specifies whether this class is projected to Java clients.

Sharded​

Property Sharded As %Integer [ InitialExpression = 0 ];

0 if table is not sharded, 1 if it is sharded on the shard manager, 2 if it is sharded on the shard itself.

SoapBindingStyle​

Property SoapBindingStyle As %RawString [ InitialExpression = "document" ];

Specifies the SOAP Binding used by this class when it is used to send and receive mnessages via SOAP.

SoapBodyUse​

Property SoapBodyUse As %RawString [ InitialExpression = "literal" ];

Specifies the encoding used for SOAP messages.

SqlCategory​

Property SqlCategory As %RawString [ InitialExpression = "STRING" ];

In the case of a datatype class, specifies a type to use for calculations in SQL. Datatype classes must specify an SQL Category.

SqlRoutinePrefix​

Property SqlRoutinePrefix As %RawString;

Deprecated.

SqlRowIdName​

Property SqlRowIdName As %RawString;

In the case of a persistent class, specifies an altername field name used for the ID column. By default the ID is called ID.

SqlRowIdPrivate​

Property SqlRowIdPrivate As %Boolean [ InitialExpression = 0 ];

In the case of a persistent class, specifies whether the ID column is projected to ODBC as a hidden field.

SqlTableName​

Property SqlTableName As %RawString;

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.

Storages​

Relationship Storages As %Dictionary.StorageDefinition [ Cardinality = children, Inverse = parent ];

Storage

StorageStrategy​

Property StorageStrategy As %RawString;

Specifies the name of the storage strategy used to control persistence for this class.

Super​

Property Super As %RawString;

Specifies one or more superclasses for the class.

System​

Property System As %RawString [ ClientName = _System, InitialExpression = 0 ];

Specifies the order to compile classes in when compiling a set, we always proceed in the order 1,2,3,4,0 where 0 is the default if not specified.

TimeChanged​

Property TimeChanged As %RawString;

Gives the time the last change was made to the class.

TimeCreated​

Property TimeCreated As %RawString;

Gives the time the class was first created.

Triggers​

Relationship Triggers As %Dictionary.TriggerDefinition [ Cardinality = children, Inverse = parent ];

Trigger

TriggerClass​

Property TriggerClass As %RawString;

Additional trigger member super classes to inherit.

UDLTexts​

Relationship UDLTexts As %Dictionary.UDLTextDefinition [ Cardinality = children, Inverse = parent ];

UDLText

ViewQuery​

Property ViewQuery As %RawString;

Gives the SQL query used for View definition of this class.

XDatas​

Relationship XDatas As %Dictionary.XDataDefinition [ Cardinality = children, Inverse = parent ];

XData

Triggers​

OnInsertUpdate​

Trigger OnInsertUpdate [ Event = INSERT/UPDATE ]

OnDelete​

Trigger OnDelete [ Event = DELETE, Time = AFTER ]

Methods​

ClassVersionSet​

Method ClassVersionSet(val As %String) As %Status

%IsClsOpen​

ClassMethod %IsClsOpen(cls As %String) As %RegisteredObject

ClientDataTypeIsValid​

ClassMethod ClientDataTypeIsValid(val As %String) As %Status

InheritanceIsValid​

ClassMethod InheritanceIsValid(val As %String) As %Status

ModifiedIsValid​

ClassMethod ModifiedIsValid(val As %String) As %Status

OdbcTypeIsValid​

ClassMethod OdbcTypeIsValid(val As %String) As %Status

ServerOnlyIsValid​

ClassMethod ServerOnlyIsValid(val As %String) As %Status

SoapBindingStyleIsValid​

ClassMethod SoapBindingStyleIsValid(val As %String) As %Status

SoapBodyUseIsValid​

ClassMethod SoapBodyUseIsValid(val As %String) As %Status

SqlCategoryIsValid​

ClassMethod SqlCategoryIsValid(val As %String) As %Status

SystemIsValid​

ClassMethod SystemIsValid(val As %String) As %Status

%OnNew​

Method %OnNew(name As %String, classversion As %Integer) As %Status [ Private ]

%LockId​

ClassMethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) As %Status

%UnlockId​

ClassMethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) As %Status

%Exists​

ClassMethod %Exists(oid As %ObjectIdentity) As %Boolean

%LoadData​

Method %LoadData(id As %String) As %Status [ Private ]

%SaveData​

Method %SaveData(id As %String) As %Status [ Private ]

%DeleteData​

ClassMethod %DeleteData(id As %String, concurrency As %Integer) As %Status [ Private ]

AbstractSet​

Method AbstractSet(value As %String = "") As %Status

AbstractReset​

Method AbstractReset()

AbstractIsDefined​

Method AbstractIsDefined() As %Boolean

ClassDefinitionErrorSet​

Method ClassDefinitionErrorSet(value As %String = "") As %Status

ClassDefinitionErrorReset​

Method ClassDefinitionErrorReset()

ClassDefinitionErrorIsDefined​

Method ClassDefinitionErrorIsDefined() As %Boolean

ClassTypeSet​

Method ClassTypeSet(value As %String = "") As %Status

ClassTypeReset​

Method ClassTypeReset()

ClassTypeIsDefined​

Method ClassTypeIsDefined() As %Boolean

ClientDataTypeSet​

Method ClientDataTypeSet(value As %String = "") As %Status

ClientDataTypeReset​

Method ClientDataTypeReset()

ClientDataTypeIsDefined​

Method ClientDataTypeIsDefined() As %Boolean

ClientNameSet​

Method ClientNameSet(value As %String = "") As %Status

ClientNameReset​

Method ClientNameReset()

ClientNameIsDefined​

Method ClientNameIsDefined() As %Boolean

CompileAfterSet​

Method CompileAfterSet(value As %String = "") As %Status

CompileAfterReset​

Method CompileAfterReset()

CompileAfterIsDefined​

Method CompileAfterIsDefined() As %Boolean

ConstraintClassSet​

Method ConstraintClassSet(value As %String = "") As %Status

ConstraintClassReset​

Method ConstraintClassReset()

ConstraintClassIsDefined​

Method ConstraintClassIsDefined() As %Boolean

CopyrightSet​

Method CopyrightSet(value As %String = "") As %Status

CopyrightReset​

Method CopyrightReset()

CopyrightIsDefined​

Method CopyrightIsDefined() As %Boolean

DdlAllowedSet​

Method DdlAllowedSet(value As %String = "") As %Status

DdlAllowedReset​

Method DdlAllowedReset()

DdlAllowedIsDefined​

Method DdlAllowedIsDefined() As %Boolean

DependsOnSet​

Method DependsOnSet(value As %String = "") As %Status

DependsOnReset​

Method DependsOnReset()

DependsOnIsDefined​

Method DependsOnIsDefined() As %Boolean

DeployedSet​

Method DeployedSet(value As %String = "") As %Status

DeployedReset​

Method DeployedReset()

DeployedIsDefined​

Method DeployedIsDefined() As %Boolean

DeprecatedSet​

Method DeprecatedSet(value As %String = "") As %Status

DeprecatedReset​

Method DeprecatedReset()

DeprecatedIsDefined​

Method DeprecatedIsDefined() As %Boolean

DescriptionSet​

Method DescriptionSet(value As %String = "") As %Status

DescriptionReset​

Method DescriptionReset()

DescriptionIsDefined​

Method DescriptionIsDefined() As %Boolean

DynamicSet​

Method DynamicSet(value As %String = "") As %Status

DynamicReset​

Method DynamicReset()

DynamicIsDefined​

Method DynamicIsDefined() As %Boolean

EmbeddedClassSet​

Method EmbeddedClassSet(value As %String = "") As %Status

EmbeddedClassReset​

Method EmbeddedClassReset()

EmbeddedClassIsDefined​

Method EmbeddedClassIsDefined() As %Boolean

FinalSet​

Method FinalSet(value As %String = "") As %Status

FinalReset​

Method FinalReset()

FinalIsDefined​

Method FinalIsDefined() As %Boolean

GeneratedBySet​

Method GeneratedBySet(value As %String = "") As %Status

GeneratedByReset​

Method GeneratedByReset()

GeneratedByIsDefined​

Method GeneratedByIsDefined() As %Boolean

HiddenSet​

Method HiddenSet(value As %String = "") As %Status

HiddenReset​

Method HiddenReset()

HiddenIsDefined​

Method HiddenIsDefined() As %Boolean

ImportSet​

Method ImportSet(value As %String = "") As %Status

ImportReset​

Method ImportReset()

ImportIsDefined​

Method ImportIsDefined() As %Boolean

IncludeCodeSet​

Method IncludeCodeSet(value As %String = "") As %Status

IncludeCodeReset​

Method IncludeCodeReset()

IncludeCodeIsDefined​

Method IncludeCodeIsDefined() As %Boolean

IncludeGeneratorSet​

Method IncludeGeneratorSet(value As %String = "") As %Status

IncludeGeneratorReset​

Method IncludeGeneratorReset()

IncludeGeneratorIsDefined​

Method IncludeGeneratorIsDefined() As %Boolean

IndexClassSet​

Method IndexClassSet(value As %String = "") As %Status

IndexClassReset​

Method IndexClassReset()

IndexClassIsDefined​

Method IndexClassIsDefined() As %Boolean

InheritanceSet​

Method InheritanceSet(value As %String = "") As %Status

InheritanceReset​

Method InheritanceReset()

InheritanceIsDefined​

Method InheritanceIsDefined() As %Boolean

LanguageSet​

Method LanguageSet(value As %String = "") As %Status

LanguageReset​

Method LanguageReset()

LanguageIsDefined​

Method LanguageIsDefined() As %Boolean

LegacyInstanceContextSet​

Method LegacyInstanceContextSet(value As %String = "") As %Status

LegacyInstanceContextReset​

Method LegacyInstanceContextReset()

LegacyInstanceContextIsDefined​

Method LegacyInstanceContextIsDefined() As %Boolean

MemberSuperSet​

Method MemberSuperSet(value As %String = "") As %Status

MemberSuperReset​

Method MemberSuperReset()

MemberSuperIsDefined​

Method MemberSuperIsDefined() As %Boolean

ModificationAuxiliarySet​

Method ModificationAuxiliarySet(value As %String = "") As %Status

ModificationAuxiliaryReset​

Method ModificationAuxiliaryReset()

ModificationAuxiliaryIsDefined​

Method ModificationAuxiliaryIsDefined() As %Boolean

ModificationLevelSet​

Method ModificationLevelSet(value As %String = "") As %Status

ModificationLevelReset​

Method ModificationLevelReset()

ModificationLevelIsDefined​

Method ModificationLevelIsDefined() As %Boolean

ModifiedSet​

Method ModifiedSet(value As %String = "") As %Status

ModifiedReset​

Method ModifiedReset()

ModifiedIsDefined​

Method ModifiedIsDefined() As %Boolean

NameSet​

Method NameSet(value As %String = "") As %Status

NameReset​

Method NameReset()

NameIsDefined​

Method NameIsDefined() As %Boolean

NoContextSet​

Method NoContextSet(value As %String = "") As %Status

NoContextReset​

Method NoContextReset()

NoContextIsDefined​

Method NoContextIsDefined() As %Boolean

NoExtentSet​

Method NoExtentSet(value As %String = "") As %Status

NoExtentReset​

Method NoExtentReset()

NoExtentIsDefined​

Method NoExtentIsDefined() As %Boolean

OdbcTypeSet​

Method OdbcTypeSet(value As %String = "") As %Status

OdbcTypeReset​

Method OdbcTypeReset()

OdbcTypeIsDefined​

Method OdbcTypeIsDefined() As %Boolean

OwnerSet​

Method OwnerSet(value As %String = "") As %Status

OwnerReset​

Method OwnerReset()

OwnerIsDefined​

Method OwnerIsDefined() As %Boolean

ProcedureBlockSet​

Method ProcedureBlockSet(value As %String = "") As %Status

ProcedureBlockReset​

Method ProcedureBlockReset()

ProcedureBlockIsDefined​

Method ProcedureBlockIsDefined() As %Boolean

ProjectionClassSet​

Method ProjectionClassSet(value As %String = "") As %Status

ProjectionClassReset​

Method ProjectionClassReset()

ProjectionClassIsDefined​

Method ProjectionClassIsDefined() As %Boolean

PropertyClassSet​

Method PropertyClassSet(value As %String = "") As %Status

PropertyClassReset​

Method PropertyClassReset()

PropertyClassIsDefined​

Method PropertyClassIsDefined() As %Boolean

QueryClassSet​

Method QueryClassSet(value As %String = "") As %Status

QueryClassReset​

Method QueryClassReset()

QueryClassIsDefined​

Method QueryClassIsDefined() As %Boolean

ServerOnlySet​

Method ServerOnlySet(value As %String = "") As %Status

ServerOnlyReset​

Method ServerOnlyReset()

ServerOnlyIsDefined​

Method ServerOnlyIsDefined() As %Boolean

ShardedSet​

Method ShardedSet(value As %String = "") As %Status

ShardedReset​

Method ShardedReset()

ShardedIsDefined​

Method ShardedIsDefined() As %Boolean

SoapBindingStyleSet​

Method SoapBindingStyleSet(value As %String = "") As %Status

SoapBindingStyleReset​

Method SoapBindingStyleReset()

SoapBindingStyleIsDefined​

Method SoapBindingStyleIsDefined() As %Boolean

SoapBodyUseSet​

Method SoapBodyUseSet(value As %String = "") As %Status

SoapBodyUseReset​

Method SoapBodyUseReset()

SoapBodyUseIsDefined​

Method SoapBodyUseIsDefined() As %Boolean

SqlCategorySet​

Method SqlCategorySet(value As %String = "") As %Status

SqlCategoryReset​

Method SqlCategoryReset()

SqlCategoryIsDefined​

Method SqlCategoryIsDefined() As %Boolean

SqlRoutinePrefixSet​

Method SqlRoutinePrefixSet(value As %String = "") As %Status

SqlRoutinePrefixReset​

Method SqlRoutinePrefixReset()

SqlRoutinePrefixIsDefined​

Method SqlRoutinePrefixIsDefined() As %Boolean

SqlRowIdNameSet​

Method SqlRowIdNameSet(value As %String = "") As %Status

SqlRowIdNameReset​

Method SqlRowIdNameReset()

SqlRowIdNameIsDefined​

Method SqlRowIdNameIsDefined() As %Boolean

SqlRowIdPrivateSet​

Method SqlRowIdPrivateSet(value As %String = "") As %Status

SqlRowIdPrivateReset​

Method SqlRowIdPrivateReset()

SqlRowIdPrivateIsDefined​

Method SqlRowIdPrivateIsDefined() As %Boolean

SqlTableNameSet​

Method SqlTableNameSet(value As %String = "") As %Status

SqlTableNameReset​

Method SqlTableNameReset()

SqlTableNameIsDefined​

Method SqlTableNameIsDefined() As %Boolean

StorageStrategySet​

Method StorageStrategySet(value As %String = "") As %Status

StorageStrategyReset​

Method StorageStrategyReset()

StorageStrategyIsDefined​

Method StorageStrategyIsDefined() As %Boolean

SuperSet​

Method SuperSet(value As %String = "") As %Status

SuperReset​

Method SuperReset()

SuperIsDefined​

Method SuperIsDefined() As %Boolean

SystemSet​

Method SystemSet(value As %String = "") As %Status

SystemReset​

Method SystemReset()

SystemIsDefined​

Method SystemIsDefined() As %Boolean

TimeChangedSet​

Method TimeChangedSet(value As %String = "") As %Status

TimeChangedReset​

Method TimeChangedReset()

TimeChangedIsDefined​

Method TimeChangedIsDefined() As %Boolean

TimeCreatedSet​

Method TimeCreatedSet(value As %String = "") As %Status

TimeCreatedReset​

Method TimeCreatedReset()

TimeCreatedIsDefined​

Method TimeCreatedIsDefined() As %Boolean

TriggerClassSet​

Method TriggerClassSet(value As %String = "") As %Status

TriggerClassReset​

Method TriggerClassReset()

TriggerClassIsDefined​

Method TriggerClassIsDefined() As %Boolean

ViewQuerySet​

Method ViewQuerySet(value As %String = "") As %Status

ViewQueryReset​

Method ViewQueryReset()

ViewQueryIsDefined​

Method ViewQueryIsDefined() As %Boolean

NormalizeClassname​

ClassMethod NormalizeClassname(classname As %String) As %String