Properties (Including Private)Copy link to this section
property %isDefined as %CacheString [ Private , MultiDimensional , Transient ];
Copy link to this section
Stores the DEFINED state of each attribute.
Property methods: %isDefinedGet(), %isDefinedIsValid(), %isDefinedSet()
property Abstract as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that the class cannot have instances; for datatypes, specifies that the class cannot be used as an attribute type.
Property methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsDefined(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractReset(), AbstractSet()
property ClassDefinitionError as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Set to true if there is a problem serializing the class so the compiler knows not to compile this.
Property methods: ClassDefinitionErrorDisplayToLogical(), ClassDefinitionErrorGet(), ClassDefinitionErrorIsDefined(), ClassDefinitionErrorIsValid(), ClassDefinitionErrorLogicalToDisplay(), ClassDefinitionErrorNormalize(), ClassDefinitionErrorReset(), ClassDefinitionErrorSet()
property ClassType as %CacheString ;
Copy link to this section
Specifies how this class is to be used.
Property methods: ClassTypeGet(), ClassTypeIsDefined(), ClassTypeIsValid(), ClassTypeReset(), ClassTypeSet()
property ClassVersion as %Integer [ InitialExpression = 23 , Transient ];
Copy link to this section
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 methods: ClassVersionDisplayToLogical(), ClassVersionGet(), ClassVersionIsValid(), ClassVersionLogicalToDisplay(), ClassVersionNormalize(), ClassVersionSet()
property ClientDataType as %CacheString [ InitialExpression = "VARCHAR" ];
Copy link to this section
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 methods: ClientDataTypeGet(), ClientDataTypeIsDefined(), ClientDataTypeIsValid(), ClientDataTypeReset(), ClientDataTypeSet()
property ClientName as %CacheString ;
Copy link to this section
This gives an alternate name for the class if it projected, for example, to Java.
Property methods: ClientNameGet(), ClientNameIsDefined(), ClientNameIsValid(), ClientNameReset(), ClientNameSet()
property CompileAfter as %CacheString ;
Copy link to this section
Indicates that the class compiler should compile this class after the specified classes.
Property methods: CompileAfterGet(), CompileAfterIsDefined(), CompileAfterIsValid(), CompileAfterReset(), CompileAfterSet()
property ConstraintClass as %CacheString ;
Copy link to this section
Additional constraint member super classes to inherit.
Property methods: ConstraintClassGet(), ConstraintClassIsDefined(), ConstraintClassIsValid(), ConstraintClassReset(), ConstraintClassSet()
property DdlAllowed as %Boolean [ InitialExpression = 0 ];
Copy link to this section
In the case of a persistent class, indicates whether or not DDL statements can be used to alter or delete the class definition.
Property methods: DdlAllowedDisplayToLogical(), DdlAllowedGet(), DdlAllowedIsDefined(), DdlAllowedIsValid(), DdlAllowedLogicalToDisplay(), DdlAllowedNormalize(), DdlAllowedReset(), DdlAllowedSet()
property DependsOn as %CacheString ;
Copy link to this section
List of classes that this class depends on being runable in order for this class to compile.
Property methods: DependsOnGet(), DependsOnIsDefined(), DependsOnIsValid(), DependsOnReset(), DependsOnSet()
property Deployed as %Integer [ InitialExpression = 0 ];
Copy link to this section
Indicates whether the class has been deployed, that is, disassociated from the source that was used to build it.
Property methods: DeployedDisplayToLogical(), DeployedGet(), DeployedIsDefined(), DeployedIsValid(), DeployedLogicalToDisplay(), DeployedNormalize(), DeployedReset(), DeployedSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
Copy link to this section
True if this class is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %CacheString ;
Copy link to this section
Specifies a description of the class.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property Dynamic as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Deprecated.
Property methods: DynamicDisplayToLogical(), DynamicGet(), DynamicIsDefined(), DynamicIsValid(), DynamicLogicalToDisplay(), DynamicNormalize(), DynamicReset(), DynamicSet()
property EmbeddedClass as %CacheString ;
Copy link to this section
If specified in a member type class is the name of the class which forms the embedded superclass
Property methods: EmbeddedClassGet(), EmbeddedClassIsDefined(), EmbeddedClassIsValid(), EmbeddedClassReset(), EmbeddedClassSet()
property Final as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that the class cannot have subclasses.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsDefined(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalReset(), FinalSet()
relationship ForeignKeys as array of %Dictionary.ForeignKeyDefinition [ InitialExpression = $listbuild("%Dictionary.ForeignKeyDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
ForeignKey
Property methods: ForeignKeysGet(), ForeignKeysGetObject(), ForeignKeysGetObjectId(), ForeignKeysGetSwizzled(), ForeignKeysIsEmpty(), ForeignKeysIsValid(), ForeignKeysNewObject(), ForeignKeysRClose(), ForeignKeysRExec(), ForeignKeysRFetch(), ForeignKeysRelate(), ForeignKeysSQLCompute(), ForeignKeysSet(), ForeignKeysUnRelate()
property GeneratedBy as %CacheString ;
Copy link to this section
If this class is generated by some other component then this is the name of the item that generated this class
Property methods: GeneratedByGet(), GeneratedByIsDefined(), GeneratedByIsValid(), GeneratedByReset(), GeneratedBySet()
property Hidden as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that this class is not typically listed when viewing the contents of the class dictionary.
Property methods: HiddenDisplayToLogical(), HiddenGet(), HiddenIsDefined(), HiddenIsValid(), HiddenLogicalToDisplay(), HiddenNormalize(), HiddenReset(), HiddenSet()
Supplies a list of class packages to import for this class.
Property methods: ImportGet(), ImportIsDefined(), ImportIsValid(), ImportReset(), ImportSet()
property IncludeCode as %CacheString ;
Copy link to this section
Specifies an optional list of Cache include files used when compiling this class.
Property methods: IncludeCodeGet(), IncludeCodeIsDefined(), IncludeCodeIsValid(), IncludeCodeReset(), IncludeCodeSet()
property IncludeGenerator as %CacheString ;
Copy link to this section
Specifies an optional list of Cache include files used when compiling the method generator methods of this class.
Property methods: IncludeGeneratorGet(), IncludeGeneratorIsDefined(), IncludeGeneratorIsValid(), IncludeGeneratorReset(), IncludeGeneratorSet()
property IndexClass as %CacheString ;
Copy link to this section
Additional index member super classes to inherit.
Property methods: IndexClassGet(), IndexClassIsDefined(), IndexClassIsValid(), IndexClassReset(), IndexClassSet()
relationship Indices as array of %Dictionary.IndexDefinition [ InitialExpression = $listbuild("%Dictionary.IndexDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Index
Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()
property Inheritance as %CacheString [ InitialExpression = "left" ];
Copy link to this section
Define the inheritance order when using multiple inheritance, if a member exists in multiple superclasses which one will take precedence.
Property methods: InheritanceGet(), InheritanceIsDefined(), InheritanceIsValid(), InheritanceReset(), InheritanceSet()
property Language as %CacheString [ SqlFieldName = _Language , InitialExpression = "cache" ];
Copy link to this section
The default language used to implement methods for this class.
Property methods: LanguageGet(), LanguageIsDefined(), LanguageIsValid(), LanguageReset(), LanguageSet()
property LegacyInstanceContext as %Boolean [ InitialExpression = 0 ];
Copy link to this section
If true then pass %this as first argument of all instance methods
Property methods: LegacyInstanceContextDisplayToLogical(), LegacyInstanceContextGet(), LegacyInstanceContextIsDefined(), LegacyInstanceContextIsValid(), LegacyInstanceContextLogicalToDisplay(), LegacyInstanceContextNormalize(), LegacyInstanceContextReset(), LegacyInstanceContextSet()
property MemberSuper as %CacheString ;
Copy link to this section
This is the class to inherit if this class is used as a member class in member inheritance
Property methods: MemberSuperGet(), MemberSuperIsDefined(), MemberSuperIsValid(), MemberSuperReset(), MemberSuperSet()
relationship Methods as array of %Dictionary.MethodDefinition [ InitialExpression = $listbuild("%Dictionary.MethodDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Method
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property ModificationAuxiliary as %CacheString ;
Copy link to this section
Deprecated.
Property methods: ModificationAuxiliaryGet(), ModificationAuxiliaryIsDefined(), ModificationAuxiliaryIsValid(), ModificationAuxiliaryReset(), ModificationAuxiliarySet()
property ModificationLevel as %Integer [ InitialExpression = 9 ];
Copy link to this section
Deprecated.
Property methods: ModificationLevelDisplayToLogical(), ModificationLevelGet(), ModificationLevelIsDefined(), ModificationLevelIsValid(), ModificationLevelLogicalToDisplay(), ModificationLevelNormalize(), ModificationLevelReset(), ModificationLevelSet()
property Modified as %CacheString [ InitialExpression = 3 ];
Copy link to this section
If set to 0 then class is always modified, and so it is always saved.
Property methods: ModifiedGet(), ModifiedIsDefined(), ModifiedIsValid(), ModifiedReset(), ModifiedSet()
The name of the class.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NoContext as %Boolean [ InitialExpression = 0 ];
Copy link to this section
NoContext
Property methods: NoContextDisplayToLogical(), NoContextGet(), NoContextIsDefined(), NoContextIsValid(), NoContextLogicalToDisplay(), NoContextNormalize(), NoContextReset(), NoContextSet()
property NoExtent as %Boolean [ InitialExpression = 0 ];
Copy link to this section
If TRUE will prevent this class from instantiating a persistent extent.
Property methods: NoExtentDisplayToLogical(), NoExtentGet(), NoExtentIsDefined(), NoExtentIsValid(), NoExtentLogicalToDisplay(), NoExtentNormalize(), NoExtentReset(), NoExtentSet()
property OdbcType as %CacheString [ InitialExpression = "VARCHAR" ];
Copy link to this section
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 methods: OdbcTypeGet(), OdbcTypeIsDefined(), OdbcTypeIsValid(), OdbcTypeReset(), OdbcTypeSet()
Specifies the owner of the class and its corresponding table. By default, classes and tables are owned by _SYSTEM.
Property methods: OwnerGet(), OwnerIsDefined(), OwnerIsValid(), OwnerReset(), OwnerSet()
relationship Parameters as array of %Dictionary.ParameterDefinition [ InitialExpression = $listbuild("%Dictionary.ParameterDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Parameter
Property methods: ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsEmpty(), ParametersIsValid(), ParametersNewObject(), ParametersRClose(), ParametersRExec(), ParametersRFetch(), ParametersRelate(), ParametersSQLCompute(), ParametersSet(), ParametersUnRelate()
property ProcedureBlock as %Boolean [ InitialExpression = 0 ];
Copy link to this section
Specifies that the class uses procedure block for method code.
Property methods: ProcedureBlockDisplayToLogical(), ProcedureBlockGet(), ProcedureBlockIsDefined(), ProcedureBlockIsValid(), ProcedureBlockLogicalToDisplay(), ProcedureBlockNormalize(), ProcedureBlockReset(), ProcedureBlockSet()
property ProjectionClass as %CacheString ;
Copy link to this section
Additional projection member super classes to inherit.
Property methods: ProjectionClassGet(), ProjectionClassIsDefined(), ProjectionClassIsValid(), ProjectionClassReset(), ProjectionClassSet()
relationship Projections as array of %Dictionary.ProjectionDefinition [ InitialExpression = $listbuild("%Dictionary.ProjectionDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Projection
Property methods: ProjectionsGet(), ProjectionsGetObject(), ProjectionsGetObjectId(), ProjectionsGetSwizzled(), ProjectionsIsEmpty(), ProjectionsIsValid(), ProjectionsNewObject(), ProjectionsRClose(), ProjectionsRExec(), ProjectionsRFetch(), ProjectionsRelate(), ProjectionsSQLCompute(), ProjectionsSet(), ProjectionsUnRelate()
relationship Properties as array of %Dictionary.PropertyDefinition [ InitialExpression = $listbuild("%Dictionary.PropertyDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Property
Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()
property PropertyClass as %CacheString ;
Copy link to this section
Additional property member super classes to inherit.
Property methods: PropertyClassGet(), PropertyClassIsDefined(), PropertyClassIsValid(), PropertyClassReset(), PropertyClassSet()
relationship Queries as array of %Dictionary.QueryDefinition [ InitialExpression = $listbuild("%Dictionary.QueryDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Query
Property methods: QueriesGet(), QueriesGetObject(), QueriesGetObjectId(), QueriesGetSwizzled(), QueriesIsEmpty(), QueriesIsValid(), QueriesNewObject(), QueriesRClose(), QueriesRExec(), QueriesRFetch(), QueriesRelate(), QueriesSQLCompute(), QueriesSet(), QueriesUnRelate()
property QueryClass as %CacheString ;
Copy link to this section
Additional query member super classes to inherit.
Property methods: QueryClassGet(), QueryClassIsDefined(), QueryClassIsValid(), QueryClassReset(), QueryClassSet()
property ServerOnly as %CacheString ;
Copy link to this section
ServerOnly
Property methods: ServerOnlyGet(), ServerOnlyIsDefined(), ServerOnlyIsValid(), ServerOnlyReset(), ServerOnlySet()
property SoapBindingStyle as %CacheString [ InitialExpression = "document" ];
Copy link to this section
Specifies the SOAP Binding used by this class when it is used to send and receive mnessages via SOAP.
Property methods: SoapBindingStyleGet(), SoapBindingStyleIsDefined(), SoapBindingStyleIsValid(), SoapBindingStyleReset(), SoapBindingStyleSet()
property SoapBodyUse as %CacheString [ InitialExpression = "literal" ];
Copy link to this section
Specifies the encoding used for SOAP messages.
Property methods: SoapBodyUseGet(), SoapBodyUseIsDefined(), SoapBodyUseIsValid(), SoapBodyUseReset(), SoapBodyUseSet()
property SqlCategory as %CacheString [ InitialExpression = "STRING" ];
Copy link to this section
In the case of a datatype class, specifies a type to use for calculations in SQL. Datatype classes must specify an SQL Category.
Property methods: SqlCategoryGet(), SqlCategoryIsDefined(), SqlCategoryIsValid(), SqlCategoryReset(), SqlCategorySet()
property SqlRoutinePrefix as %CacheString ;
Copy link to this section
Deprecated.
Property methods: SqlRoutinePrefixGet(), SqlRoutinePrefixIsDefined(), SqlRoutinePrefixIsValid(), SqlRoutinePrefixReset(), SqlRoutinePrefixSet()
property SqlRowIdName as %CacheString ;
Copy link to this section
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 methods: SqlRowIdNameGet(), SqlRowIdNameIsDefined(), SqlRowIdNameIsValid(), SqlRowIdNameReset(), SqlRowIdNameSet()
property SqlRowIdPrivate as %Boolean [ InitialExpression = 0 ];
Copy link to this section
In the case of a persistent class, specifies whether the ID column is projected to ODBC as a hidden field.
Property methods: SqlRowIdPrivateDisplayToLogical(), SqlRowIdPrivateGet(), SqlRowIdPrivateIsDefined(), SqlRowIdPrivateIsValid(), SqlRowIdPrivateLogicalToDisplay(), SqlRowIdPrivateNormalize(), SqlRowIdPrivateReset(), SqlRowIdPrivateSet()
property SqlTableName as %CacheString ;
Copy link to this section
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 methods: SqlTableNameGet(), SqlTableNameIsDefined(), SqlTableNameIsValid(), SqlTableNameReset(), SqlTableNameSet()
property StorageStrategy as %CacheString ;
Copy link to this section
Specifies the name of the storage strategy used to control persistence for this class.
Property methods: StorageStrategyGet(), StorageStrategyIsDefined(), StorageStrategyIsValid(), StorageStrategyReset(), StorageStrategySet()
relationship Storages as array of %Dictionary.StorageDefinition [ InitialExpression = $listbuild("%Dictionary.StorageDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Storage
Property methods: StoragesGet(), StoragesGetObject(), StoragesGetObjectId(), StoragesGetSwizzled(), StoragesIsEmpty(), StoragesIsValid(), StoragesNewObject(), StoragesRClose(), StoragesRExec(), StoragesRFetch(), StoragesRelate(), StoragesSQLCompute(), StoragesSet(), StoragesUnRelate()
Specifies one or more superclasses for the class.
Property methods: SuperGet(), SuperIsDefined(), SuperIsValid(), SuperReset(), SuperSet()
property System as %CacheString [ InitialExpression = 0 ];
Copy link to this section
Specifies that the class is internal to the implementation of Cache. Users should not mark their classes with this keyword.
Property methods: SystemGet(), SystemIsDefined(), SystemIsValid(), SystemReset(), SystemSet()
property TimeChanged as %CacheString ;
Copy link to this section
Gives the time the last change was made to the class.
Property methods: TimeChangedGet(), TimeChangedIsDefined(), TimeChangedIsValid(), TimeChangedReset(), TimeChangedSet()
property TimeCreated as %CacheString ;
Copy link to this section
Gives the time the class was first created.
Property methods: TimeCreatedGet(), TimeCreatedIsDefined(), TimeCreatedIsValid(), TimeCreatedReset(), TimeCreatedSet()
property TriggerClass as %CacheString ;
Copy link to this section
Additional trigger member super classes to inherit.
Property methods: TriggerClassGet(), TriggerClassIsDefined(), TriggerClassIsValid(), TriggerClassReset(), TriggerClassSet()
relationship Triggers as array of %Dictionary.TriggerDefinition [ InitialExpression = $listbuild("%Dictionary.TriggerDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
Trigger
Property methods: TriggersGet(), TriggersGetObject(), TriggersGetObjectId(), TriggersGetSwizzled(), TriggersIsEmpty(), TriggersIsValid(), TriggersNewObject(), TriggersRClose(), TriggersRExec(), TriggersRFetch(), TriggersRelate(), TriggersSQLCompute(), TriggersSet(), TriggersUnRelate()
relationship UDLTexts as array of %Dictionary.UDLTextDefinition [ InitialExpression = $listbuild("%Dictionary.UDLTextDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
UDLText
Property methods: UDLTextsGet(), UDLTextsGetObject(), UDLTextsGetObjectId(), UDLTextsGetSwizzled(), UDLTextsIsEmpty(), UDLTextsIsValid(), UDLTextsNewObject(), UDLTextsRClose(), UDLTextsRExec(), UDLTextsRFetch(), UDLTextsRelate(), UDLTextsSQLCompute(), UDLTextsSet(), UDLTextsUnRelate()
property ViewQuery as %CacheString ;
Copy link to this section
Gives the SQL query used for View definition of this class.
Property methods: ViewQueryGet(), ViewQueryIsDefined(), ViewQueryIsValid(), ViewQueryReset(), ViewQuerySet()
relationship XDatas as array of %Dictionary.XDataDefinition [ InitialExpression = $listbuild("%Dictionary.XDataDefinition","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Copy link to this section
XData
Property methods: XDatasGet(), XDatasGetObject(), XDatasGetObjectId(), XDatasGetSwizzled(), XDatasIsEmpty(), XDatasIsValid(), XDatasNewObject(), XDatasRClose(), XDatasRExec(), XDatasRFetch(), XDatasRelate(), XDatasSQLCompute(), XDatasSet(), XDatasUnRelate()