This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

%Dictionary.ClassDefinition

persistent class %Dictionary.ClassDefinition extends %Library.Persistent, %Dictionary.ClassDefinitionQuery

SQL Table Name: %Dictionary.ClassDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property %isDefined as %CacheString [ Private , MultiDimensional , Transient ];
Stores the DEFINED state of each attribute.
Property methods: %isDefinedGet(), %isDefinedIsValid(), %isDefinedSet()
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 methods: AbstractDisplayToLogical(), AbstractGet(), AbstractIsDefined(), AbstractIsValid(), AbstractLogicalToDisplay(), AbstractNormalize(), AbstractReset(), AbstractSet()
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 methods: ClassDefinitionErrorDisplayToLogical(), ClassDefinitionErrorGet(), ClassDefinitionErrorIsDefined(), ClassDefinitionErrorIsValid(), ClassDefinitionErrorLogicalToDisplay(), ClassDefinitionErrorNormalize(), ClassDefinitionErrorReset(), ClassDefinitionErrorSet()
property ClassType as %CacheString;
Specifies how this class is to be used.
Property methods: ClassTypeGet(), ClassTypeIsDefined(), ClassTypeIsValid(), ClassTypeReset(), ClassTypeSet()
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 methods: ClassVersionDisplayToLogical(), ClassVersionGet(), ClassVersionIsValid(), ClassVersionLogicalToDisplay(), ClassVersionNormalize(), ClassVersionSet()
property ClientDataType as %CacheString [ 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 methods: ClientDataTypeGet(), ClientDataTypeIsDefined(), ClientDataTypeIsValid(), ClientDataTypeReset(), ClientDataTypeSet()
property ClientName as %CacheString;
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;
Indicates that the class compiler should compile this class after the specified classes.
Property methods: CompileAfterGet(), CompileAfterIsDefined(), CompileAfterIsValid(), CompileAfterReset(), CompileAfterSet()
property ConstraintClass as %CacheString;
Additional constraint member super classes to inherit.
Property methods: ConstraintClassGet(), ConstraintClassIsDefined(), ConstraintClassIsValid(), ConstraintClassReset(), ConstraintClassSet()
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 methods: DdlAllowedDisplayToLogical(), DdlAllowedGet(), DdlAllowedIsDefined(), DdlAllowedIsValid(), DdlAllowedLogicalToDisplay(), DdlAllowedNormalize(), DdlAllowedReset(), DdlAllowedSet()
property DependsOn as %CacheString;
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 ];
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 ];
True if this class is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the class.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property Dynamic as %Boolean [ InitialExpression = 0 ];
Deprecated.
Property methods: DynamicDisplayToLogical(), DynamicGet(), DynamicIsDefined(), DynamicIsValid(), DynamicLogicalToDisplay(), DynamicNormalize(), DynamicReset(), DynamicSet()
property EmbeddedClass as %CacheString;
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 ];
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 ];
ForeignKey
Property methods: ForeignKeysGet(), ForeignKeysGetObject(), ForeignKeysGetObjectId(), ForeignKeysGetSwizzled(), ForeignKeysIsEmpty(), ForeignKeysIsValid(), ForeignKeysNewObject(), ForeignKeysRClose(), ForeignKeysRExec(), ForeignKeysRFetch(), ForeignKeysRelate(), ForeignKeysSQLCompute(), ForeignKeysSet(), ForeignKeysUnRelate()
property GeneratedBy as %CacheString;
If this class is generated by some other component then this is the name of the item that generated this class
Property methods: GeneratedByGet(), GeneratedByIsDefined(), GeneratedByIsValid(), GeneratedByReset(), GeneratedBySet()
property Hidden as %Boolean [ InitialExpression = 0 ];
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 %CacheString;
Supplies a list of class packages to import for this class.
Property methods: ImportGet(), ImportIsDefined(), ImportIsValid(), ImportReset(), ImportSet()
property IncludeCode as %CacheString;
Specifies an optional list of Cache include files used when compiling this class.
Property methods: IncludeCodeGet(), IncludeCodeIsDefined(), IncludeCodeIsValid(), IncludeCodeReset(), IncludeCodeSet()
property IncludeGenerator as %CacheString;
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;
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 ];
Index
Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()
property Inheritance as %CacheString [ InitialExpression = "left" ];
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" ];
The default language used to implement methods for this class.
Property methods: LanguageGet(), LanguageIsDefined(), LanguageIsValid(), LanguageReset(), LanguageSet()
property LegacyInstanceContext as %Boolean [ InitialExpression = 0 ];
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;
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 ];
Method
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property ModificationAuxiliary as %CacheString;
Deprecated.
Property methods: ModificationAuxiliaryGet(), ModificationAuxiliaryIsDefined(), ModificationAuxiliaryIsValid(), ModificationAuxiliaryReset(), ModificationAuxiliarySet()
property ModificationLevel as %Integer [ InitialExpression = 9 ];
Deprecated.
Property methods: ModificationLevelDisplayToLogical(), ModificationLevelGet(), ModificationLevelIsDefined(), ModificationLevelIsValid(), ModificationLevelLogicalToDisplay(), ModificationLevelNormalize(), ModificationLevelReset(), ModificationLevelSet()
property Modified as %CacheString [ InitialExpression = 3 ];
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.CacheClassname [ Required ];
The name of the class.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NoContext as %Boolean [ InitialExpression = 0 ];
NoContext
Property methods: NoContextDisplayToLogical(), NoContextGet(), NoContextIsDefined(), NoContextIsValid(), NoContextLogicalToDisplay(), NoContextNormalize(), NoContextReset(), NoContextSet()
property NoExtent as %Boolean [ InitialExpression = 0 ];
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" ];
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 Owner as %CacheString;
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 ];
Parameter
Property methods: ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsEmpty(), ParametersIsValid(), ParametersNewObject(), ParametersRClose(), ParametersRExec(), ParametersRFetch(), ParametersRelate(), ParametersSQLCompute(), ParametersSet(), ParametersUnRelate()
property ProcedureBlock as %Boolean [ InitialExpression = 0 ];
Specifies that the class uses procedure block for method code.
Property methods: ProcedureBlockDisplayToLogical(), ProcedureBlockGet(), ProcedureBlockIsDefined(), ProcedureBlockIsValid(), ProcedureBlockLogicalToDisplay(), ProcedureBlockNormalize(), ProcedureBlockReset(), ProcedureBlockSet()
property ProjectionClass as %CacheString;
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 ];
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 ];
Property
Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()
property PropertyClass as %CacheString;
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 ];
Query
Property methods: QueriesGet(), QueriesGetObject(), QueriesGetObjectId(), QueriesGetSwizzled(), QueriesIsEmpty(), QueriesIsValid(), QueriesNewObject(), QueriesRClose(), QueriesRExec(), QueriesRFetch(), QueriesRelate(), QueriesSQLCompute(), QueriesSet(), QueriesUnRelate()
property QueryClass as %CacheString;
Additional query member super classes to inherit.
Property methods: QueryClassGet(), QueryClassIsDefined(), QueryClassIsValid(), QueryClassReset(), QueryClassSet()
property ServerOnly as %CacheString;
ServerOnly
Property methods: ServerOnlyGet(), ServerOnlyIsDefined(), ServerOnlyIsValid(), ServerOnlyReset(), ServerOnlySet()
property SoapBindingStyle as %CacheString [ InitialExpression = "document" ];
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" ];
Specifies the encoding used for SOAP messages.
Property methods: SoapBodyUseGet(), SoapBodyUseIsDefined(), SoapBodyUseIsValid(), SoapBodyUseReset(), SoapBodyUseSet()
property SqlCategory as %CacheString [ 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 methods: SqlCategoryGet(), SqlCategoryIsDefined(), SqlCategoryIsValid(), SqlCategoryReset(), SqlCategorySet()
property SqlRoutinePrefix as %CacheString;
Deprecated.
Property methods: SqlRoutinePrefixGet(), SqlRoutinePrefixIsDefined(), SqlRoutinePrefixIsValid(), SqlRoutinePrefixReset(), SqlRoutinePrefixSet()
property SqlRowIdName as %CacheString;
In the case of a persistent class, specifies an altername field name used for the ID column. By default the ID is called ID.
Property methods: SqlRowIdNameGet(), SqlRowIdNameIsDefined(), SqlRowIdNameIsValid(), SqlRowIdNameReset(), SqlRowIdNameSet()
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 methods: SqlRowIdPrivateDisplayToLogical(), SqlRowIdPrivateGet(), SqlRowIdPrivateIsDefined(), SqlRowIdPrivateIsValid(), SqlRowIdPrivateLogicalToDisplay(), SqlRowIdPrivateNormalize(), SqlRowIdPrivateReset(), SqlRowIdPrivateSet()
property SqlTableName as %CacheString;
In the case of a persistent class, specifies the table name used to identify the class in its SQL projection. By default, the SQL table name is the same as the class name.
Property methods: SqlTableNameGet(), SqlTableNameIsDefined(), SqlTableNameIsValid(), SqlTableNameReset(), SqlTableNameSet()
property StorageStrategy as %CacheString;
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 ];
Storage
Property methods: StoragesGet(), StoragesGetObject(), StoragesGetObjectId(), StoragesGetSwizzled(), StoragesIsEmpty(), StoragesIsValid(), StoragesNewObject(), StoragesRClose(), StoragesRExec(), StoragesRFetch(), StoragesRelate(), StoragesSQLCompute(), StoragesSet(), StoragesUnRelate()
property Super as %CacheString;
Specifies one or more superclasses for the class.
Property methods: SuperGet(), SuperIsDefined(), SuperIsValid(), SuperReset(), SuperSet()
property System as %CacheString [ InitialExpression = 0 ];
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;
Gives the time the last change was made to the class.
Property methods: TimeChangedGet(), TimeChangedIsDefined(), TimeChangedIsValid(), TimeChangedReset(), TimeChangedSet()
property TimeCreated as %CacheString;
Gives the time the class was first created.
Property methods: TimeCreatedGet(), TimeCreatedIsDefined(), TimeCreatedIsValid(), TimeCreatedReset(), TimeCreatedSet()
property TriggerClass as %CacheString;
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 ];
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 ];
UDLText
Property methods: UDLTextsGet(), UDLTextsGetObject(), UDLTextsGetObjectId(), UDLTextsGetSwizzled(), UDLTextsIsEmpty(), UDLTextsIsValid(), UDLTextsNewObject(), UDLTextsRClose(), UDLTextsRExec(), UDLTextsRFetch(), UDLTextsRelate(), UDLTextsSQLCompute(), UDLTextsSet(), UDLTextsUnRelate()
property ViewQuery as %CacheString;
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 ];
XData
Property methods: XDatasGet(), XDatasGetObject(), XDatasGetObjectId(), XDatasGetSwizzled(), XDatasIsEmpty(), XDatasIsValid(), XDatasNewObject(), XDatasRClose(), XDatasRExec(), XDatasRFetch(), XDatasRelate(), XDatasSQLCompute(), XDatasSet(), XDatasUnRelate()

Methods (Including Private)

private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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.

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

Indexes

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

Triggers

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

Inherited Members

Inherited Methods (Including Private)