persistent class %Dictionary.ClassDefinition
extends %Persistent, %Dictionary.ClassDefinitionQuery
• parameter SQLENABLED = 1;
• 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.
• 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.
• property ClassType
as %RawString;
Specifies how this class is to be used.
• 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.
• 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.
• property ClientName
as %RawString;
This gives an alternate name for the class if it projected, for example, to Java.
• property CompileAfter
as %RawString;
Indicates that the class compiler should compile this class after the specified classes.
• property ConstraintClass
as %RawString;
Additional constraint member super classes to inherit.
• property Copyright
as %RawString;
Optional copyright notice associated with this class
• 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.
• property DependsOn
as %RawString;
List of classes that this class depends on being runable in order for this class to compile.
• 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.
• property Deprecated
as %Boolean [ InitialExpression = 0 ];
True if this class is deprecated.
• property Description
as %RawString;
Specifies a description of the class.
• property Dynamic
as %Boolean [ InitialExpression = 0 ];
Deprecated.
• property EmbeddedClass
as %RawString;
If specified in a member type class is the name of the class which forms the embedded superclass
• property Final
as %Boolean [ InitialExpression = 0 ];
Specifies that the class cannot have subclasses.
• relationship ForeignKeys
as %Dictionary.ForeignKeyDefinition [ Inverse = parent,Cardinality = children ];
ForeignKey
• 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
• property Hidden
as %Boolean [ InitialExpression = 0 ];
Specifies that this class is not typically listed when viewing the contents of the class dictionary.
• property Import
as %RawString;
Supplies a list of class packages to import for this class.
• property IncludeCode
as %RawString;
Specifies an optional list of include files used when compiling this class.
• property IncludeGenerator
as %RawString;
Specifies an optional list of include files used when compiling the method generator methods of this class.
• property IndexClass
as %RawString;
Additional index member super classes to inherit.
• relationship Indices
as %Dictionary.IndexDefinition [ Inverse = parent,Cardinality = children ];
Index
• 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.
• property Language
as %RawString [ SqlFieldName = _Language,InitialExpression = "objectscript" ];
The default language used to implement methods for this class.
• property LegacyInstanceContext
as %Boolean [ InitialExpression = 0 ];
If true then pass %this as first argument of all instance methods
• property MemberSuper
as %RawString;
This is the class to inherit if this class is used as a member class in member inheritance
• relationship Methods
as %Dictionary.MethodDefinition [ Inverse = parent,Cardinality = children ];
Method
• property ModificationAuxiliary
as %RawString;
Deprecated.
• property ModificationLevel
as %Integer [ InitialExpression = 9 ];
Deprecated.
• property Modified
as %RawString [ InitialExpression = 3 ];
If set to 0 then class is always modified, and so it is always saved.
• property Name
as %Dictionary.Classname [ Required ];
The name of the class.
• property NoContext
as %Boolean [ InitialExpression = 0 ];
If true, datatype methods have access to the current instance instead of providing their own context.
• property NoExtent
as %Boolean [ InitialExpression = 0 ];
If TRUE will prevent this class from instantiating a persistent extent.
• 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.
• property Owner
as %RawString;
Specifies the owner of the class and its corresponding table. By default, classes and tables are owned by _SYSTEM.
• relationship Parameters
as %Dictionary.ParameterDefinition [ Inverse = parent,Cardinality = children ];
Parameter
• property ProcedureBlock
as %Boolean [ InitialExpression = 0 ];
Specifies that the class uses procedure block for method code.
• property ProjectionClass
as %RawString;
Additional projection member super classes to inherit.
• relationship Projections
as %Dictionary.ProjectionDefinition [ Inverse = parent,Cardinality = children ];
Projection
• relationship Properties
as %Dictionary.PropertyDefinition [ Inverse = parent,Cardinality = children ];
Property
• property PropertyClass
as %RawString;
Additional property member super classes to inherit.
• relationship Queries
as %Dictionary.QueryDefinition [ Inverse = parent,Cardinality = children ];
Query
• property QueryClass
as %RawString;
Additional query member super classes to inherit.
• property ServerOnly
as %RawString;
Specifies whether this class is projected to Java clients.
• 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.
• 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.
• property SoapBodyUse
as %RawString [ InitialExpression = "literal" ];
Specifies the encoding used for SOAP messages.
• 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.
• property SqlRoutinePrefix
as %RawString;
Deprecated.
• 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.
• 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.
• 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.
• property StorageStrategy
as %RawString;
Specifies the name of the storage strategy used to control persistence for this class.
• relationship Storages
as %Dictionary.StorageDefinition [ Inverse = parent,Cardinality = children ];
Storage
• property Super
as %RawString;
Specifies one or more superclasses for the class.
• property System
as %RawString [ 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.
• property TimeChanged
as %RawString;
Gives the time the last change was made to the class.
• property TimeCreated
as %RawString;
Gives the time the class was first created.
• property TriggerClass
as %RawString;
Additional trigger member super classes to inherit.
• relationship Triggers
as %Dictionary.TriggerDefinition [ Inverse = parent,Cardinality = children ];
Trigger
• relationship UDLTexts
as %Dictionary.UDLTextDefinition [ Inverse = parent,Cardinality = children ];
UDLText
• property ViewQuery
as %RawString;
Gives the SQL query used for View definition of this class.
• relationship XDatas
as %Dictionary.XDataDefinition [ Inverse = parent,Cardinality = children ];
XData
• 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 %IsClsOpen(cls As %String)
as %RegisteredObject
• 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 %Storage.Persistent or %Storage.SQL.
• 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 %Storage.Persistent or %Storage.SQL.
• method AbstractIsDefined()
as %Boolean
• method AbstractReset()
• method AbstractSet(value As %String = "")
as %Status
This is a Set accessor method for the Abstract property.
• method ClassDefinitionErrorIsDefined()
as %Boolean
• method ClassDefinitionErrorReset()
• method ClassDefinitionErrorSet(value As %String = "")
as %Status
This is a Set accessor method for the ClassDefinitionError property.
• method ClassTypeIsDefined()
as %Boolean
• method ClassTypeReset()
• method ClassTypeSet(value As %String = "")
as %Status
This is a Set accessor method for the ClassType property.
• method ClassVersionSet(val As %String)
as %Status
This is a Set accessor method for the ClassVersion property.
• method ClientDataTypeIsDefined()
as %Boolean
• classmethod ClientDataTypeIsValid(val As %String)
as %Status
• method ClientDataTypeReset()
• method ClientDataTypeSet(value As %String = "")
as %Status
This is a Set accessor method for the ClientDataType property.
• method ClientNameIsDefined()
as %Boolean
• method ClientNameReset()
• method ClientNameSet(value As %String = "")
as %Status
This is a Set accessor method for the ClientName property.
• method CompileAfterIsDefined()
as %Boolean
• method CompileAfterReset()
• method CompileAfterSet(value As %String = "")
as %Status
This is a Set accessor method for the CompileAfter property.
• method ConstraintClassIsDefined()
as %Boolean
• method ConstraintClassReset()
• method ConstraintClassSet(value As %String = "")
as %Status
This is a Set accessor method for the ConstraintClass property.
• method CopyrightIsDefined()
as %Boolean
• method CopyrightReset()
• method CopyrightSet(value As %String = "")
as %Status
This is a Set accessor method for the Copyright property.
• method DdlAllowedIsDefined()
as %Boolean
• method DdlAllowedReset()
• method DdlAllowedSet(value As %String = "")
as %Status
This is a Set accessor method for the DdlAllowed property.
• method DependsOnIsDefined()
as %Boolean
• method DependsOnReset()
• method DependsOnSet(value As %String = "")
as %Status
This is a Set accessor method for the DependsOn property.
• method DeployedIsDefined()
as %Boolean
• method DeployedReset()
• method DeployedSet(value As %String = "")
as %Status
This is a Set accessor method for the Deployed property.
• method DeprecatedIsDefined()
as %Boolean
• method DeprecatedReset()
• method DeprecatedSet(value As %String = "")
as %Status
This is a Set accessor method for the Deprecated property.
• method DescriptionIsDefined()
as %Boolean
• method DescriptionReset()
• method DescriptionSet(value As %String = "")
as %Status
This is a Set accessor method for the Description property.
• method DynamicIsDefined()
as %Boolean
• method DynamicReset()
• method DynamicSet(value As %String = "")
as %Status
This is a Set accessor method for the Dynamic property.
• method EmbeddedClassIsDefined()
as %Boolean
• method EmbeddedClassReset()
• method EmbeddedClassSet(value As %String = "")
as %Status
This is a Set accessor method for the EmbeddedClass property.
• method FinalIsDefined()
as %Boolean
• method FinalReset()
• method FinalSet(value As %String = "")
as %Status
This is a Set accessor method for the Final property.
• method GeneratedByIsDefined()
as %Boolean
• method GeneratedByReset()
• method GeneratedBySet(value As %String = "")
as %Status
This is a Set accessor method for the GeneratedBy property.
• method HiddenIsDefined()
as %Boolean
• method HiddenReset()
• method HiddenSet(value As %String = "")
as %Status
This is a Set accessor method for the Hidden property.
• method ImportIsDefined()
as %Boolean
• method ImportReset()
• method ImportSet(value As %String = "")
as %Status
This is a Set accessor method for the Import property.
• method IncludeCodeIsDefined()
as %Boolean
• method IncludeCodeReset()
• method IncludeCodeSet(value As %String = "")
as %Status
This is a Set accessor method for the IncludeCode property.
• method IncludeGeneratorIsDefined()
as %Boolean
• method IncludeGeneratorReset()
• method IncludeGeneratorSet(value As %String = "")
as %Status
This is a Set accessor method for the IncludeGenerator property.
• method IndexClassIsDefined()
as %Boolean
• method IndexClassReset()
• method IndexClassSet(value As %String = "")
as %Status
This is a Set accessor method for the IndexClass property.
• method InheritanceIsDefined()
as %Boolean
• classmethod InheritanceIsValid(val As %String)
as %Status
• method InheritanceReset()
• method InheritanceSet(value As %String = "")
as %Status
This is a Set accessor method for the Inheritance property.
• method LanguageIsDefined()
as %Boolean
• method LanguageReset()
• method LanguageSet(value As %String = "")
as %Status
This is a Set accessor method for the Language property.
• method LegacyInstanceContextIsDefined()
as %Boolean
• method LegacyInstanceContextReset()
• method LegacyInstanceContextSet(value As %String = "")
as %Status
This is a Set accessor method for the LegacyInstanceContext property.
• method MemberSuperIsDefined()
as %Boolean
• method MemberSuperReset()
• method MemberSuperSet(value As %String = "")
as %Status
This is a Set accessor method for the MemberSuper property.
• method ModificationAuxiliaryIsDefined()
as %Boolean
• method ModificationAuxiliaryReset()
• method ModificationAuxiliarySet(value As %String = "")
as %Status
This is a Set accessor method for the ModificationAuxiliary property.
• method ModificationLevelIsDefined()
as %Boolean
• method ModificationLevelReset()
• method ModificationLevelSet(value As %String = "")
as %Status
This is a Set accessor method for the ModificationLevel property.
• method ModifiedIsDefined()
as %Boolean
• classmethod ModifiedIsValid(val As %String)
as %Status
• method ModifiedReset()
• method ModifiedSet(value As %String = "")
as %Status
This is a Set accessor method for the Modified property.
• method NameIsDefined()
as %Boolean
• method NameReset()
• method NameSet(value As %String = "")
as %Status
This is a Set accessor method for the Name property.
• method NoContextIsDefined()
as %Boolean
• method NoContextReset()
• method NoContextSet(value As %String = "")
as %Status
This is a Set accessor method for the NoContext property.
• method NoExtentIsDefined()
as %Boolean
• method NoExtentReset()
• method NoExtentSet(value As %String = "")
as %Status
This is a Set accessor method for the NoExtent property.
• classmethod NormalizeClassname(classname As %String)
as %String
• method OdbcTypeIsDefined()
as %Boolean
• classmethod OdbcTypeIsValid(val As %String)
as %Status
• method OdbcTypeReset()
• method OdbcTypeSet(value As %String = "")
as %Status
This is a Set accessor method for the OdbcType property.
• method OwnerIsDefined()
as %Boolean
• method OwnerReset()
• method OwnerSet(value As %String = "")
as %Status
This is a Set accessor method for the Owner property.
• method ProcedureBlockIsDefined()
as %Boolean
• method ProcedureBlockReset()
• method ProcedureBlockSet(value As %String = "")
as %Status
This is a Set accessor method for the ProcedureBlock property.
• method ProjectionClassIsDefined()
as %Boolean
• method ProjectionClassReset()
• method ProjectionClassSet(value As %String = "")
as %Status
This is a Set accessor method for the ProjectionClass property.
• method PropertyClassIsDefined()
as %Boolean
• method PropertyClassReset()
• method PropertyClassSet(value As %String = "")
as %Status
This is a Set accessor method for the PropertyClass property.
• method QueryClassIsDefined()
as %Boolean
• method QueryClassReset()
• method QueryClassSet(value As %String = "")
as %Status
This is a Set accessor method for the QueryClass property.
• method ServerOnlyIsDefined()
as %Boolean
• classmethod ServerOnlyIsValid(val As %String)
as %Status
• method ServerOnlyReset()
• method ServerOnlySet(value As %String = "")
as %Status
This is a Set accessor method for the ServerOnly property.
• method ShardedIsDefined()
as %Boolean
• method ShardedReset()
• method ShardedSet(value As %String = "")
as %Status
This is a Set accessor method for the Sharded property.
• method SoapBindingStyleIsDefined()
as %Boolean
• classmethod SoapBindingStyleIsValid(val As %String)
as %Status
• method SoapBindingStyleReset()
• method SoapBindingStyleSet(value As %String = "")
as %Status
This is a Set accessor method for the SoapBindingStyle property.
• method SoapBodyUseIsDefined()
as %Boolean
• classmethod SoapBodyUseIsValid(val As %String)
as %Status
• method SoapBodyUseReset()
• method SoapBodyUseSet(value As %String = "")
as %Status
This is a Set accessor method for the SoapBodyUse property.
• method SqlCategoryIsDefined()
as %Boolean
• classmethod SqlCategoryIsValid(val As %String)
as %Status
• method SqlCategoryReset()
• method SqlCategorySet(value As %String = "")
as %Status
This is a Set accessor method for the SqlCategory property.
• method SqlRoutinePrefixIsDefined()
as %Boolean
• method SqlRoutinePrefixReset()
• method SqlRoutinePrefixSet(value As %String = "")
as %Status
This is a Set accessor method for the SqlRoutinePrefix property.
• method SqlRowIdNameIsDefined()
as %Boolean
• method SqlRowIdNameReset()
• method SqlRowIdNameSet(value As %String = "")
as %Status
This is a Set accessor method for the SqlRowIdName property.
• method SqlRowIdPrivateIsDefined()
as %Boolean
• method SqlRowIdPrivateReset()
• method SqlRowIdPrivateSet(value As %String = "")
as %Status
This is a Set accessor method for the SqlRowIdPrivate property.
• method SqlTableNameIsDefined()
as %Boolean
• method SqlTableNameReset()
• method SqlTableNameSet(value As %String = "")
as %Status
This is a Set accessor method for the SqlTableName property.
• method StorageStrategyIsDefined()
as %Boolean
• method StorageStrategyReset()
• method StorageStrategySet(value As %String = "")
as %Status
This is a Set accessor method for the StorageStrategy property.
• method SuperIsDefined()
as %Boolean
• method SuperReset()
• method SuperSet(value As %String = "")
as %Status
This is a Set accessor method for the Super property.
• method SystemIsDefined()
as %Boolean
• classmethod SystemIsValid(val As %String)
as %Status
• method SystemReset()
• method SystemSet(value As %String = "")
as %Status
This is a Set accessor method for the System property.
• method TimeChangedIsDefined()
as %Boolean
• method TimeChangedReset()
• method TimeChangedSet(value As %String = "")
as %Status
This is a Set accessor method for the TimeChanged property.
• method TimeCreatedIsDefined()
as %Boolean
• method TimeCreatedReset()
• method TimeCreatedSet(value As %String = "")
as %Status
This is a Set accessor method for the TimeCreated property.
• method TriggerClassIsDefined()
as %Boolean
• method TriggerClassReset()
• method TriggerClassSet(value As %String = "")
as %Status
This is a Set accessor method for the TriggerClass property.
• method ViewQueryIsDefined()
as %Boolean
• method ViewQueryReset()
• method ViewQuerySet(value As %String = "")
as %Status
This is a Set accessor method for the ViewQuery property.
•index (IDKEY on Name) [IdKey];
•trigger OnDelete
(AFTER event DELETE)•trigger OnInsertUpdate
(BEFORE event INSERT/UPDATE)
