Home > Class Reference > %SYS namespace > %Dictionary.CompiledClass

%Dictionary.CompiledClass

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

SQL Table Name: %Dictionary.CompiledClass

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property %isDefined as %RawString [ Private , MultiDimensional , Transient ];
Stores the DEFINED state of each attribute.
Property methods: %isDefinedGet(), %isDefinedIsValid(), %isDefinedSet()
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 methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsDefined(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractReset(), AbstractSet()
property Ancestry as %RawString;
Ancestry
Property methods: AncestryGet(), AncestryIsValid(), AncestrySet()
property CacheVersion as %RawString;
The version of InterSystems IRIS this class was compiled on.
Property methods: CacheVersionGet(), CacheVersionIsValid(), CacheVersionSet()
property ClassCompileError as %RawString;
Status code from this class compile if there is an error
Property methods: ClassCompileErrorGet(), ClassCompileErrorIsValid(), ClassCompileErrorSet()
property ClassDefinitionError as %Boolean;
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 %RawString;
Specifies how this class is to be used.
Property methods: ClassTypeGet(), ClassTypeIsDefined(), ClassTypeIsValid(), ClassTypeReset(), ClassTypeSet()
property Classes as array of %RawString;
Array of items generated by this class.
Property methods: ClassesBuildValueArray(), ClassesCollectionToDisplay(), ClassesCollectionToOdbc(), ClassesDisplayToCollection(), ClassesGet(), ClassesGetObject(), ClassesGetObjectId(), ClassesGetSwizzled(), ClassesIsValid(), ClassesOdbcToCollection(), ClassesSet(), ClassesSetObject(), ClassesSetObjectId()
property ClientDataType as %RawString;
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: ClientDataTypeEnumDisplayToLogical(), ClientDataTypeEnumGet(), ClientDataTypeEnumIsValid(), ClientDataTypeEnumLogicalToDisplay(), ClientDataTypeEnumNormalize(), ClientDataTypeEnumSet(), ClientDataTypeGet(), ClientDataTypeIsDefined(), ClientDataTypeIsValid(), ClientDataTypeReset(), ClientDataTypeSet()
property ClientDataTypeEnum as %Integer;
ClientDataTypeEnum
Property methods: ClientDataTypeEnumDisplayToLogical(), ClientDataTypeEnumGet(), ClientDataTypeEnumIsValid(), ClientDataTypeEnumLogicalToDisplay(), ClientDataTypeEnumNormalize(), ClientDataTypeEnumSet()
property ClientInfo as array of %RawString;
ClientInfo
Property methods: ClientInfoBuildValueArray(), ClientInfoCollectionToDisplay(), ClientInfoCollectionToOdbc(), ClientInfoDisplayToCollection(), ClientInfoGet(), ClientInfoGetObject(), ClientInfoGetObjectId(), ClientInfoGetSwizzled(), ClientInfoIsValid(), ClientInfoOdbcToCollection(), ClientInfoSet(), ClientInfoSetObject(), ClientInfoSetObjectId()
property ClientName as %RawString;
This gives an alternate name for the class if it projected, for example, to Java.
Property methods: ClientNameGet(), ClientNameIsDefined(), ClientNameIsValid(), ClientNameReset(), ClientNameSet()
property CompilationSignature as %RawString;
CompilationSignature
Property methods: CompilationSignatureGet(), CompilationSignatureIsValid(), CompilationSignatureSet()
property CompileAfter as %RawString;
Indicates that the class compiler should compile this class after the specified classes.
Property methods: CompileAfterGet(), CompileAfterIsDefined(), CompileAfterIsValid(), CompileAfterReset(), CompileAfterSet()
property CompileNamespace as %RawString;
The namespace when this class is compiled, used to help dependency checking.
Property methods: CompileNamespaceGet(), CompileNamespaceIsValid(), CompileNamespaceSet()
property ConstraintClass as %RawString;
Additional constraint member super classes to inherit.
Property methods: ConstraintClassGet(), ConstraintClassIsDefined(), ConstraintClassIsValid(), ConstraintClassReset(), ConstraintClassSet()
relationship Constraints as array of %Dictionary.CompiledConstraint [ InitialExpression = $listbuild("%Dictionary.CompiledConstraint","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Constraint
Property methods: ConstraintsGet(), ConstraintsGetObject(), ConstraintsGetObjectId(), ConstraintsGetSwizzled(), ConstraintsIsEmpty(), ConstraintsIsValid(), ConstraintsNewObject(), ConstraintsRClose(), ConstraintsRExec(), ConstraintsRFetch(), ConstraintsRelate(), ConstraintsSQLCompute(), ConstraintsSet(), ConstraintsUnRelate()
Optional copyright notice associated with this class
Property methods: CopyrightGet(), CopyrightIsDefined(), CopyrightIsValid(), CopyrightReset(), CopyrightSet()
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 methods: DdlAllowedDisplayToLogical(), DdlAllowedGet(), DdlAllowedIsDefined(), DdlAllowedIsValid(), DdlAllowedLogicalToDisplay(), DdlAllowedNormalize(), DdlAllowedReset(), DdlAllowedSet()
property DependsOn as %RawString;
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;
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;
True if this class is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Specifies a description of the class.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property Dynamic as %Boolean;
Deprecated.
Property methods: DynamicDisplayToLogical(), DynamicGet(), DynamicIsDefined(), DynamicIsValid(), DynamicLogicalToDisplay(), DynamicNormalize(), DynamicReset(), DynamicSet()
property EmbeddedClass as %RawString;
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 Extents as array of %RawString;
Extents
Property methods: ExtentsBuildValueArray(), ExtentsCollectionToDisplay(), ExtentsCollectionToOdbc(), ExtentsDisplayToCollection(), ExtentsGet(), ExtentsGetObject(), ExtentsGetObjectId(), ExtentsGetSwizzled(), ExtentsIsValid(), ExtentsOdbcToCollection(), ExtentsSet(), ExtentsSetObject(), ExtentsSetObjectId()
property Final as %Boolean;
Specifies that the class cannot have subclasses.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsDefined(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalReset(), FinalSet()
relationship ForeignKeys as array of %Dictionary.CompiledForeignKey [ InitialExpression = $listbuild("%Dictionary.CompiledForeignKey","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
ForeignKey
Property methods: ForeignKeysGet(), ForeignKeysGetObject(), ForeignKeysGetObjectId(), ForeignKeysGetSwizzled(), ForeignKeysIsEmpty(), ForeignKeysIsValid(), ForeignKeysNewObject(), ForeignKeysRClose(), ForeignKeysRExec(), ForeignKeysRFetch(), ForeignKeysRelate(), ForeignKeysSQLCompute(), ForeignKeysSet(), ForeignKeysUnRelate()
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 methods: GeneratedByGet(), GeneratedByIsDefined(), GeneratedByIsValid(), GeneratedByReset(), GeneratedBySet()
property HasCPP as %RawString;
True if this class has C++ methods.
Property methods: HasCPPGet(), HasCPPIsValid(), HasCPPSet()
property Hash as %RawString;
A hash of this class so we can detect when it is changed.
Property methods: HashGet(), HashIsValid(), HashSet()
property Hidden as %Boolean;
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()
property Import as %RawString;
Supplies a list of class packages to import for this class.
Property methods: ImportGet(), ImportIsDefined(), ImportIsValid(), ImportReset(), ImportSet(), ImportallBuildValueArray(), ImportallCollectionToDisplay(), ImportallCollectionToOdbc(), ImportallDisplayToCollection(), ImportallGet(), ImportallGetObject(), ImportallGetObjectId(), ImportallGetSwizzled(), ImportallIsValid(), ImportallOdbcToCollection(), ImportallSet(), ImportallSetObject(), ImportallSetObjectId()
property Importall as array of %RawString;
Importall
Property methods: ImportallBuildValueArray(), ImportallCollectionToDisplay(), ImportallCollectionToOdbc(), ImportallDisplayToCollection(), ImportallGet(), ImportallGetObject(), ImportallGetObjectId(), ImportallGetSwizzled(), ImportallIsValid(), ImportallOdbcToCollection(), ImportallSet(), ImportallSetObject(), ImportallSetObjectId()
property IncludeCode as %RawString;
Specifies an optional list of include files used when compiling this class.
Property methods: IncludeCodeAllBuildValueArray(), IncludeCodeAllCollectionToDisplay(), IncludeCodeAllCollectionToOdbc(), IncludeCodeAllDisplayToCollection(), IncludeCodeAllGet(), IncludeCodeAllGetObject(), IncludeCodeAllGetObjectId(), IncludeCodeAllGetSwizzled(), IncludeCodeAllIsValid(), IncludeCodeAllOdbcToCollection(), IncludeCodeAllSet(), IncludeCodeAllSetObject(), IncludeCodeAllSetObjectId(), IncludeCodeGet(), IncludeCodeIsDefined(), IncludeCodeIsValid(), IncludeCodeReset(), IncludeCodeSet()
property IncludeCodeAll as array of %RawString;
IncludeCodeAll
Property methods: IncludeCodeAllBuildValueArray(), IncludeCodeAllCollectionToDisplay(), IncludeCodeAllCollectionToOdbc(), IncludeCodeAllDisplayToCollection(), IncludeCodeAllGet(), IncludeCodeAllGetObject(), IncludeCodeAllGetObjectId(), IncludeCodeAllGetSwizzled(), IncludeCodeAllIsValid(), IncludeCodeAllOdbcToCollection(), IncludeCodeAllSet(), IncludeCodeAllSetObject(), IncludeCodeAllSetObjectId()
property IncludeGenerator as %RawString;
Specifies an optional list of include files used when compiling the method generator methods of this class.
Property methods: IncludeGeneratorGet(), IncludeGeneratorIsDefined(), IncludeGeneratorIsValid(), IncludeGeneratorReset(), IncludeGeneratorSet()
property IncludeMGenAll as array of %RawString;
IncludeMGenAll
Property methods: IncludeMGenAllBuildValueArray(), IncludeMGenAllCollectionToDisplay(), IncludeMGenAllCollectionToOdbc(), IncludeMGenAllDisplayToCollection(), IncludeMGenAllGet(), IncludeMGenAllGetObject(), IncludeMGenAllGetObjectId(), IncludeMGenAllGetSwizzled(), IncludeMGenAllIsValid(), IncludeMGenAllOdbcToCollection(), IncludeMGenAllSet(), IncludeMGenAllSetObject(), IncludeMGenAllSetObjectId()
property IndexClass as %RawString;
Additional index member super classes to inherit.
Property methods: IndexClassGet(), IndexClassIsDefined(), IndexClassIsValid(), IndexClassReset(), IndexClassSet()
relationship Indices as array of %Dictionary.CompiledIndex [ InitialExpression = $listbuild("%Dictionary.CompiledIndex","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Index
Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()
property Inheritance as %RawString;
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 InitialValue as %RawString;
If specified the initial serial value for a new object
Property methods: InitialValueGet(), InitialValueIsValid(), InitialValueSet()
relationship InstanceVars as array of %Dictionary.CompiledInstanceVar [ InitialExpression = $listbuild("%Dictionary.CompiledInstanceVar","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
InstanceVar
Property methods: InstanceVarsGet(), InstanceVarsGetObject(), InstanceVarsGetObjectId(), InstanceVarsGetSwizzled(), InstanceVarsIsEmpty(), InstanceVarsIsValid(), InstanceVarsNewObject(), InstanceVarsRClose(), InstanceVarsRExec(), InstanceVarsRFetch(), InstanceVarsRelate(), InstanceVarsSQLCompute(), InstanceVarsSet(), InstanceVarsUnRelate()
property KeywordError as %Boolean;
KeywordError
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
KeywordModified
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
property Language as %RawString [ SqlFieldName = _Language ];
The default language used to implement methods for this class.
Property methods: LanguageGet(), LanguageIsDefined(), LanguageIsValid(), LanguageReset(), LanguageSet()
property LegacyInstanceContext as %Boolean;
If true then pass %this as first argument of all instance methods
Property methods: LegacyInstanceContextDisplayToLogical(), LegacyInstanceContextGet(), LegacyInstanceContextIsDefined(), LegacyInstanceContextIsValid(), LegacyInstanceContextLogicalToDisplay(), LegacyInstanceContextNormalize(), LegacyInstanceContextReset(), LegacyInstanceContextSet()
property Manifest as array of %RawString;
Array of items projected with this class which need to be included in any deployment package we create from this class
Property methods: ManifestBuildValueArray(), ManifestCollectionToDisplay(), ManifestCollectionToOdbc(), ManifestDisplayToCollection(), ManifestGet(), ManifestGetObject(), ManifestGetObjectId(), ManifestGetSwizzled(), ManifestIsValid(), ManifestOdbcToCollection(), ManifestSet(), ManifestSetObject(), ManifestSetObjectId()
property MemberSuper as %RawString;
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.CompiledMethod [ InitialExpression = $listbuild("%Dictionary.CompiledMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Method
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property ModificationAuxiliary as %RawString;
Deprecated.
Property methods: ModificationAuxiliaryGet(), ModificationAuxiliaryIsDefined(), ModificationAuxiliaryIsValid(), ModificationAuxiliaryReset(), ModificationAuxiliarySet()
property ModificationLevel as %Integer;
Deprecated.
Property methods: ModificationLevelDisplayToLogical(), ModificationLevelGet(), ModificationLevelIsDefined(), ModificationLevelIsValid(), ModificationLevelLogicalToDisplay(), ModificationLevelNormalize(), ModificationLevelReset(), ModificationLevelSet()
property Modified as %RawString;
If set to 0 then class is always modified, and so it is always saved.
Property methods: ModifiedGet(), ModifiedIsDefined(), ModifiedIsValid(), ModifiedReset(), ModifiedSet()
property Name as %Dictionary.Classname [ Required ];
The name of the class.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NoContext as %Boolean;
NoContext
Property methods: NoContextDisplayToLogical(), NoContextGet(), NoContextIsDefined(), NoContextIsValid(), NoContextLogicalToDisplay(), NoContextNormalize(), NoContextReset(), NoContextSet()
property NoExtent as %Boolean;
If TRUE will prevent this class from instantiating a persistent extent.
Property methods: NoExtentDisplayToLogical(), NoExtentGet(), NoExtentIsDefined(), NoExtentIsValid(), NoExtentLogicalToDisplay(), NoExtentNormalize(), NoExtentReset(), NoExtentSet()
property OdbcType as %RawString;
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()
property OldHash as %RawString;
Keep track of old hash values so we can modify a class without marking it as out of date.
Property methods: OldHashGet(), OldHashIsValid(), OldHashSet()
property Owner as %RawString;
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.CompiledParameter [ InitialExpression = $listbuild("%Dictionary.CompiledParameter","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Parameter
Property methods: ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsEmpty(), ParametersIsValid(), ParametersNewObject(), ParametersRClose(), ParametersRExec(), ParametersRFetch(), ParametersRelate(), ParametersSQLCompute(), ParametersSet(), ParametersUnRelate()
property PrimarySuper as %RawString;
PrimarySuper
Property methods: PrimarySuperGet(), PrimarySuperIsValid(), PrimarySuperSet()
property ProcedureBlock as %Boolean;
Specifies that the class uses procedure block for method code.
Property methods: ProcedureBlockDisplayToLogical(), ProcedureBlockGet(), ProcedureBlockIsDefined(), ProcedureBlockIsValid(), ProcedureBlockLogicalToDisplay(), ProcedureBlockNormalize(), ProcedureBlockReset(), ProcedureBlockSet()
property Procedures as array of %RawString;
Procedures
Property methods: ProceduresBuildValueArray(), ProceduresCollectionToDisplay(), ProceduresCollectionToOdbc(), ProceduresDisplayToCollection(), ProceduresGet(), ProceduresGetObject(), ProceduresGetObjectId(), ProceduresGetSwizzled(), ProceduresIsValid(), ProceduresOdbcToCollection(), ProceduresSet(), ProceduresSetObject(), ProceduresSetObjectId()
property ProjectionClass as %RawString;
Additional projection member super classes to inherit.
Property methods: ProjectionClassGet(), ProjectionClassIsDefined(), ProjectionClassIsValid(), ProjectionClassReset(), ProjectionClassSet()
relationship Projections as array of %Dictionary.CompiledProjection [ InitialExpression = $listbuild("%Dictionary.CompiledProjection","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Projection
Property methods: ProjectionsGet(), ProjectionsGetObject(), ProjectionsGetObjectId(), ProjectionsGetSwizzled(), ProjectionsIsEmpty(), ProjectionsIsValid(), ProjectionsNewObject(), ProjectionsRClose(), ProjectionsRExec(), ProjectionsRFetch(), ProjectionsRelate(), ProjectionsSQLCompute(), ProjectionsSet(), ProjectionsUnRelate()
relationship Properties as array of %Dictionary.CompiledProperty [ InitialExpression = $listbuild("%Dictionary.CompiledProperty","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property
Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()
property PropertyClass as %RawString;
Additional property member super classes to inherit.
Property methods: PropertyClassGet(), PropertyClassIsDefined(), PropertyClassIsValid(), PropertyClassReset(), PropertyClassSet()
relationship Queries as array of %Dictionary.CompiledQuery [ InitialExpression = $listbuild("%Dictionary.CompiledQuery","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Query
Property methods: QueriesGet(), QueriesGetObject(), QueriesGetObjectId(), QueriesGetSwizzled(), QueriesIsEmpty(), QueriesIsValid(), QueriesNewObject(), QueriesRClose(), QueriesRExec(), QueriesRFetch(), QueriesRelate(), QueriesSQLCompute(), QueriesSet(), QueriesUnRelate()
property QueryClass as %RawString;
Additional query member super classes to inherit.
Property methods: QueryClassGet(), QueryClassIsDefined(), QueryClassIsValid(), QueryClassReset(), QueryClassSet()
property QueryPropInfo as %Boolean;
Deprecated.
Property methods: QueryPropInfoDisplayToLogical(), QueryPropInfoGet(), QueryPropInfoIsValid(), QueryPropInfoLogicalToDisplay(), QueryPropInfoNormalize(), QueryPropInfoSet()
property RandomSig as %RawString;
Random value that is updated each time the class is compiled
Property methods: RandomSigGet(), RandomSigIsValid(), RandomSigSet()
property RoutineCount as %Integer;
RoutineCount
Property methods: RoutineCountDisplayToLogical(), RoutineCountGet(), RoutineCountIsValid(), RoutineCountLogicalToDisplay(), RoutineCountNormalize(), RoutineCountSet()
property Routines as array of %RawString;
Routines
Property methods: RoutinesBuildValueArray(), RoutinesCollectionToDisplay(), RoutinesCollectionToOdbc(), RoutinesDisplayToCollection(), RoutinesGet(), RoutinesGetObject(), RoutinesGetObjectId(), RoutinesGetSwizzled(), RoutinesIsValid(), RoutinesOdbcToCollection(), RoutinesSet(), RoutinesSetObject(), RoutinesSetObjectId()
property ServerOnly as %RawString;
ServerOnly
Property methods: ServerOnlyGet(), ServerOnlyIsDefined(), ServerOnlyIsValid(), ServerOnlyReset(), ServerOnlySet()
property Sharded as %Integer;
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 methods: ShardedDisplayToLogical(), ShardedGet(), ShardedIsDefined(), ShardedIsValid(), ShardedLogicalToDisplay(), ShardedNormalize(), ShardedReset(), ShardedSet()
property SlotCount as %Integer;
SlotCount
Property methods: SlotCountDisplayToLogical(), SlotCountGet(), SlotCountIsValid(), SlotCountLogicalToDisplay(), SlotCountNormalize(), SlotCountSet()
property SoapBindingStyle as %RawString;
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 %RawString;
Specifies the encoding used for SOAP messages.
Property methods: SoapBodyUseGet(), SoapBodyUseIsDefined(), SoapBodyUseIsValid(), SoapBodyUseReset(), SoapBodyUseSet()
property SqlCategory as %RawString;
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 SqlQualifiedNameQ as %RawString;
SqlQualifiedNameQ
Property methods: SqlQualifiedNameQGet(), SqlQualifiedNameQIsValid(), SqlQualifiedNameQSet()
property SqlRoutinePrefix as %RawString;
Deprecated.
Property methods: SqlRoutinePrefixGet(), SqlRoutinePrefixIsDefined(), SqlRoutinePrefixIsValid(), SqlRoutinePrefixReset(), SqlRoutinePrefixSet()
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 methods: SqlRowIdNameGet(), SqlRowIdNameIsDefined(), SqlRowIdNameIsValid(), SqlRowIdNameReset(), SqlRowIdNameSet()
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 methods: SqlRowIdPrivateDisplayToLogical(), SqlRowIdPrivateGet(), SqlRowIdPrivateIsDefined(), SqlRowIdPrivateIsValid(), SqlRowIdPrivateLogicalToDisplay(), SqlRowIdPrivateNormalize(), SqlRowIdPrivateReset(), SqlRowIdPrivateSet()
property SqlSchemaName as %RawString;
SqlSchemaName
Property methods: SqlSchemaNameGet(), SqlSchemaNameIsValid(), SqlSchemaNameSet()
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 methods: SqlTableNameGet(), SqlTableNameIsDefined(), SqlTableNameIsValid(), SqlTableNameReset(), SqlTableNameSet()
property StorageStrategy as %RawString;
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.CompiledStorage [ InitialExpression = $listbuild("%Dictionary.CompiledStorage","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Storage
Property methods: StoragesGet(), StoragesGetObject(), StoragesGetObjectId(), StoragesGetSwizzled(), StoragesIsEmpty(), StoragesIsValid(), StoragesNewObject(), StoragesRClose(), StoragesRExec(), StoragesRFetch(), StoragesRelate(), StoragesSQLCompute(), StoragesSet(), StoragesUnRelate()
property Structure as %RawString;
Hash of class 'structure' so we can detect when SQL related classes need to be recompiled.
Property methods: StructureGet(), StructureIsValid(), StructureSet()
property Super as %RawString;
Specifies one or more superclasses for the class.
Property methods: SuperGet(), SuperIsDefined(), SuperIsValid(), SuperReset(), SuperSet()
property System as %RawString;
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 methods: SystemGet(), SystemIsDefined(), SystemIsValid(), SystemReset(), SystemSet()
property Tables as array of %RawString;
Tables
Property methods: TablesBuildValueArray(), TablesCollectionToDisplay(), TablesCollectionToOdbc(), TablesDisplayToCollection(), TablesGet(), TablesGetObject(), TablesGetObjectId(), TablesGetSwizzled(), TablesIsValid(), TablesOdbcToCollection(), TablesSet(), TablesSetObject(), TablesSetObjectId()
property TimeChanged as %RawString;
Gives the time the last change was made to the class.
Property methods: TimeChangedGet(), TimeChangedIsDefined(), TimeChangedIsValid(), TimeChangedReset(), TimeChangedSet()
property TimeCreated as %RawString;
Gives the time the class was first created.
Property methods: TimeCreatedGet(), TimeCreatedIsDefined(), TimeCreatedIsValid(), TimeCreatedReset(), TimeCreatedSet()
property TriggerClass as %RawString;
Additional trigger member super classes to inherit.
Property methods: TriggerClassGet(), TriggerClassIsDefined(), TriggerClassIsValid(), TriggerClassReset(), TriggerClassSet()
relationship Triggers as array of %Dictionary.CompiledTrigger [ InitialExpression = $listbuild("%Dictionary.CompiledTrigger","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Trigger
Property methods: TriggersGet(), TriggersGetObject(), TriggersGetObjectId(), TriggersGetSwizzled(), TriggersIsEmpty(), TriggersIsValid(), TriggersNewObject(), TriggersRClose(), TriggersRExec(), TriggersRFetch(), TriggersRelate(), TriggersSQLCompute(), TriggersSet(), TriggersUnRelate()
relationship UDLTexts as array of %Dictionary.CompiledUDLText [ InitialExpression = $listbuild("%Dictionary.CompiledUDLText","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
UDLText
Property methods: UDLTextsGet(), UDLTextsGetObject(), UDLTextsGetObjectId(), UDLTextsGetSwizzled(), UDLTextsIsEmpty(), UDLTextsIsValid(), UDLTextsNewObject(), UDLTextsRClose(), UDLTextsRExec(), UDLTextsRFetch(), UDLTextsRelate(), UDLTextsSQLCompute(), UDLTextsSet(), UDLTextsUnRelate()
property ViewQuery as %RawString;
Gives the SQL query used for View definition of this class.
Property methods: ViewQueryGet(), ViewQueryIsDefined(), ViewQueryIsValid(), ViewQueryReset(), ViewQuerySet()
property Views as array of %RawString;
Views
Property methods: ViewsBuildValueArray(), ViewsCollectionToDisplay(), ViewsCollectionToOdbc(), ViewsDisplayToCollection(), ViewsGet(), ViewsGetObject(), ViewsGetObjectId(), ViewsGetSwizzled(), ViewsIsValid(), ViewsOdbcToCollection(), ViewsSet(), ViewsSetObject(), ViewsSetObjectId()
relationship XDatas as array of %Dictionary.CompiledXData [ InitialExpression = $listbuild("%Dictionary.CompiledXData","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
XData
Property methods: XDatasGet(), XDatasGetObject(), XDatasGetObjectId(), XDatasGetSwizzled(), XDatasIsEmpty(), XDatasIsValid(), XDatasNewObject(), XDatasRClose(), XDatasRExec(), XDatasRFetch(), XDatasRelate(), XDatasSQLCompute(), XDatasSet(), XDatasUnRelate()
property XMLData as array of %RawString;
XMLData
Property methods: XMLDataBuildValueArray(), XMLDataCollectionToDisplay(), XMLDataCollectionToOdbc(), XMLDataDisplayToCollection(), XMLDataGet(), XMLDataGetObject(), XMLDataGetObjectId(), XMLDataGetSwizzled(), XMLDataIsValid(), XMLDataOdbcToCollection(), XMLDataSet(), XMLDataSetObject(), XMLDataSetObjectId()

Methods (Including Private)

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.
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.

private method %LoadData(id As %String) as %Status [ Language = objectscript ]
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status [ Language = objectscript ]
Inherited description: 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.
private method %OnNew(name As %String) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

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.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
method AbstractReset() [ Language = objectscript ]
method AbstractSet(value As %String = "") as %Status [ Language = objectscript ]
method ClassDefinitionErrorIsDefined() as %Boolean [ Language = objectscript ]
method ClassDefinitionErrorReset() [ Language = objectscript ]
method ClassDefinitionErrorSet(value As %String = "") as %Status [ Language = objectscript ]
method ClassTypeIsDefined() as %Boolean [ Language = objectscript ]
method ClassTypeReset() [ Language = objectscript ]
method ClassTypeSet(value As %String = "") as %Status [ Language = objectscript ]
method ClientDataTypeIsDefined() as %Boolean [ Language = objectscript ]
method ClientDataTypeReset() [ Language = objectscript ]
method ClientDataTypeSet(value As %String = "") as %Status [ Language = objectscript ]
method ClientNameIsDefined() as %Boolean [ Language = objectscript ]
method ClientNameReset() [ Language = objectscript ]
method ClientNameSet(value As %String = "") as %Status [ Language = objectscript ]
method CompileAfterIsDefined() as %Boolean [ Language = objectscript ]
method CompileAfterReset() [ Language = objectscript ]
method CompileAfterSet(value As %String = "") as %Status [ Language = objectscript ]
method ConstraintClassIsDefined() as %Boolean [ Language = objectscript ]
method ConstraintClassReset() [ Language = objectscript ]
method ConstraintClassSet(value As %String = "") as %Status [ Language = objectscript ]
method CopyrightIsDefined() as %Boolean [ Language = objectscript ]
method CopyrightReset() [ Language = objectscript ]
method CopyrightSet(value As %String = "") as %Status [ Language = objectscript ]
method DdlAllowedIsDefined() as %Boolean [ Language = objectscript ]
method DdlAllowedReset() [ Language = objectscript ]
method DdlAllowedSet(value As %String = "") as %Status [ Language = objectscript ]
method DependsOnIsDefined() as %Boolean [ Language = objectscript ]
method DependsOnReset() [ Language = objectscript ]
method DependsOnSet(value As %String = "") as %Status [ Language = objectscript ]
method DeployedIsDefined() as %Boolean [ Language = objectscript ]
method DeployedReset() [ Language = objectscript ]
method DeployedSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method DynamicIsDefined() as %Boolean [ Language = objectscript ]
method DynamicReset() [ Language = objectscript ]
method DynamicSet(value As %String = "") as %Status [ Language = objectscript ]
method EmbeddedClassIsDefined() as %Boolean [ Language = objectscript ]
method EmbeddedClassReset() [ Language = objectscript ]
method EmbeddedClassSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method GeneratedByIsDefined() as %Boolean [ Language = objectscript ]
method GeneratedByReset() [ Language = objectscript ]
method GeneratedBySet(value As %String = "") as %Status [ Language = objectscript ]
method HiddenIsDefined() as %Boolean [ Language = objectscript ]
method HiddenReset() [ Language = objectscript ]
method HiddenSet(value As %String = "") as %Status [ Language = objectscript ]
method ImportIsDefined() as %Boolean [ Language = objectscript ]
method ImportReset() [ Language = objectscript ]
method ImportSet(value As %String = "") as %Status [ Language = objectscript ]
method IncludeCodeIsDefined() as %Boolean [ Language = objectscript ]
method IncludeCodeReset() [ Language = objectscript ]
method IncludeCodeSet(value As %String = "") as %Status [ Language = objectscript ]
method IncludeGeneratorIsDefined() as %Boolean [ Language = objectscript ]
method IncludeGeneratorReset() [ Language = objectscript ]
method IncludeGeneratorSet(value As %String = "") as %Status [ Language = objectscript ]
method IndexClassIsDefined() as %Boolean [ Language = objectscript ]
method IndexClassReset() [ Language = objectscript ]
method IndexClassSet(value As %String = "") as %Status [ Language = objectscript ]
method InheritanceIsDefined() as %Boolean [ Language = objectscript ]
method InheritanceReset() [ Language = objectscript ]
method InheritanceSet(value As %String = "") as %Status [ Language = objectscript ]
method LanguageIsDefined() as %Boolean [ Language = objectscript ]
method LanguageReset() [ Language = objectscript ]
method LanguageSet(value As %String = "") as %Status [ Language = objectscript ]
method LegacyInstanceContextIsDefined() as %Boolean [ Language = objectscript ]
method LegacyInstanceContextReset() [ Language = objectscript ]
method LegacyInstanceContextSet(value As %String = "") as %Status [ Language = objectscript ]
method MemberSuperIsDefined() as %Boolean [ Language = objectscript ]
method MemberSuperReset() [ Language = objectscript ]
method MemberSuperSet(value As %String = "") as %Status [ Language = objectscript ]
method ModificationAuxiliaryIsDefined() as %Boolean [ Language = objectscript ]
method ModificationAuxiliaryReset() [ Language = objectscript ]
method ModificationAuxiliarySet(value As %String = "") as %Status [ Language = objectscript ]
method ModificationLevelIsDefined() as %Boolean [ Language = objectscript ]
method ModificationLevelReset() [ Language = objectscript ]
method ModificationLevelSet(value As %String = "") as %Status [ Language = objectscript ]
method ModifiedIsDefined() as %Boolean [ Language = objectscript ]
method ModifiedReset() [ Language = objectscript ]
method ModifiedSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method NoContextIsDefined() as %Boolean [ Language = objectscript ]
method NoContextReset() [ Language = objectscript ]
method NoContextSet(value As %String = "") as %Status [ Language = objectscript ]
method NoExtentIsDefined() as %Boolean [ Language = objectscript ]
method NoExtentReset() [ Language = objectscript ]
method NoExtentSet(value As %String = "") as %Status [ Language = objectscript ]
method OdbcTypeIsDefined() as %Boolean [ Language = objectscript ]
method OdbcTypeReset() [ Language = objectscript ]
method OdbcTypeSet(value As %String = "") as %Status [ Language = objectscript ]
method OwnerIsDefined() as %Boolean [ Language = objectscript ]
method OwnerReset() [ Language = objectscript ]
method OwnerSet(value As %String = "") as %Status [ Language = objectscript ]
method ProcedureBlockIsDefined() as %Boolean [ Language = objectscript ]
method ProcedureBlockReset() [ Language = objectscript ]
method ProcedureBlockSet(value As %String = "") as %Status [ Language = objectscript ]
method ProjectionClassIsDefined() as %Boolean [ Language = objectscript ]
method ProjectionClassReset() [ Language = objectscript ]
method ProjectionClassSet(value As %String = "") as %Status [ Language = objectscript ]
method PropertyClassIsDefined() as %Boolean [ Language = objectscript ]
method PropertyClassReset() [ Language = objectscript ]
method PropertyClassSet(value As %String = "") as %Status [ Language = objectscript ]
method QueryClassIsDefined() as %Boolean [ Language = objectscript ]
method QueryClassReset() [ Language = objectscript ]
method QueryClassSet(value As %String = "") as %Status [ Language = objectscript ]
method ServerOnlyIsDefined() as %Boolean [ Language = objectscript ]
method ServerOnlyReset() [ Language = objectscript ]
method ServerOnlySet(value As %String = "") as %Status [ Language = objectscript ]
method ShardedIsDefined() as %Boolean [ Language = objectscript ]
method ShardedReset() [ Language = objectscript ]
method ShardedSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBindingStyleIsDefined() as %Boolean [ Language = objectscript ]
method SoapBindingStyleReset() [ Language = objectscript ]
method SoapBindingStyleSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBodyUseIsDefined() as %Boolean [ Language = objectscript ]
method SoapBodyUseReset() [ Language = objectscript ]
method SoapBodyUseSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlCategoryIsDefined() as %Boolean [ Language = objectscript ]
method SqlCategoryReset() [ Language = objectscript ]
method SqlCategorySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRoutinePrefixIsDefined() as %Boolean [ Language = objectscript ]
method SqlRoutinePrefixReset() [ Language = objectscript ]
method SqlRoutinePrefixSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdNameReset() [ Language = objectscript ]
method SqlRowIdNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlRowIdPrivateIsDefined() as %Boolean [ Language = objectscript ]
method SqlRowIdPrivateReset() [ Language = objectscript ]
method SqlRowIdPrivateSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlTableNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlTableNameReset() [ Language = objectscript ]
method SqlTableNameSet(value As %String = "") as %Status [ Language = objectscript ]
method StorageStrategyIsDefined() as %Boolean [ Language = objectscript ]
method StorageStrategyReset() [ Language = objectscript ]
method StorageStrategySet(value As %String = "") as %Status [ Language = objectscript ]
method SuperIsDefined() as %Boolean [ Language = objectscript ]
method SuperReset() [ Language = objectscript ]
method SuperSet(value As %String = "") as %Status [ Language = objectscript ]
method SystemIsDefined() as %Boolean [ Language = objectscript ]
method SystemReset() [ Language = objectscript ]
method SystemSet(value As %String = "") as %Status [ Language = objectscript ]
method TimeChangedIsDefined() as %Boolean [ Language = objectscript ]
method TimeChangedReset() [ Language = objectscript ]
method TimeChangedSet(value As %String = "") as %Status [ Language = objectscript ]
method TimeCreatedIsDefined() as %Boolean [ Language = objectscript ]
method TimeCreatedReset() [ Language = objectscript ]
method TimeCreatedSet(value As %String = "") as %Status [ Language = objectscript ]
method TriggerClassIsDefined() as %Boolean [ Language = objectscript ]
method TriggerClassReset() [ Language = objectscript ]
method TriggerClassSet(value As %String = "") as %Status [ Language = objectscript ]
method ViewQueryIsDefined() as %Boolean [ Language = objectscript ]
method ViewQueryReset() [ Language = objectscript ]
method ViewQuerySet(value As %String = "") as %Status [ Language = objectscript ]

Indexes

index (IDKEY on Name) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Triggers

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

Inherited Members

Inherited Methods (Including Private)

Feedback