%ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassProxy

persistent class %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassProxy extends %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.CommentableEntity

SQL Table Name: %ZHSLIB_PackageManager_Developer_Annotation_CosEntity.ClassProxy

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AcceptableAnchorTags = API.Object,API.Object.Instantiable,API.Extensible,DoesNotInheritTags;
Inherited description: tags that apply to the current entity, in addition to the universal ones (see CommonTags)
parameter XMLNAME = Class;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

property CalculatedMembers as list of %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassMemberProxy (XMLIO = "OUT", XMLPROJECTION = "element", XMLTYPECONSTRAINT = "substitutiongroup") [ Calculated ];
Property methods: CalculatedMembersCollectionToDisplay(), CalculatedMembersCollectionToOdbc(), CalculatedMembersDisplayToCollection(), CalculatedMembersGet(), CalculatedMembersOdbcToCollection()
property CalculatedNonModuleSuperclasses as list of %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.NonModuleSuperclass (XMLIO = "OUT", XMLPROJECTION = "element", XMLTYPECONSTRAINT = "substitutiongroup") [ Calculated ];
Property methods: CalculatedNonModuleSuperclassesCollectionToDisplay(), CalculatedNonModuleSuperclassesCollectionToOdbc(), CalculatedNonModuleSuperclassesDisplayToCollection(), CalculatedNonModuleSuperclassesGet(), CalculatedNonModuleSuperclassesOdbcToCollection()
relationship Members as array of %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassMemberProxy (XMLIO = "IN", XMLPROJECTION = "element", XMLTYPECONSTRAINT = "substitutiongroup") [ InitialExpression = $listbuild("%ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassMemberProxy","ParentClass",+$this,"many",1,1) , Transient , Inverse = ParentClass , Cardinality = many ];
Property methods: MembersGet(), MembersGetObject(), MembersGetObjectId(), MembersGetSwizzled(), MembersIsEmpty(), MembersIsValid(), MembersNewObject(), MembersRClose(), MembersRExec(), MembersRFetch(), MembersRelate(), MembersSQLCompute(), MembersSet(), MembersUnRelate()
property ModuleName as %String (XMLPROJECTION = "none") [ Required ];
Property methods: ModuleNameDisplayToLogical(), ModuleNameGet(), ModuleNameGetStored(), ModuleNameIsValid(), ModuleNameLogicalToDisplay(), ModuleNameLogicalToOdbc(), ModuleNameNormalize(), ModuleNameSet()
relationship NonModuleSuperclasses as array of %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.NonModuleSuperclass (XMLIO = "IN", XMLPROJECTION = "element", XMLTYPECONSTRAINT = "substitutiongroup") [ InitialExpression = $listbuild("%ZHSLIB.PackageManager.Developer.Annotation.CosEntity.NonModuleSuperclass","AppliesTo",+$this,"children",1,1) , Transient , Inverse = AppliesTo , Cardinality = children ];
Property methods: NonModuleSuperclassesGet(), NonModuleSuperclassesGetObject(), NonModuleSuperclassesGetObjectId(), NonModuleSuperclassesGetSwizzled(), NonModuleSuperclassesIsEmpty(), NonModuleSuperclassesIsValid(), NonModuleSuperclassesNewObject(), NonModuleSuperclassesRClose(), NonModuleSuperclassesRExec(), NonModuleSuperclassesRFetch(), NonModuleSuperclassesRelate(), NonModuleSuperclassesSQLCompute(), NonModuleSuperclassesSet(), NonModuleSuperclassesUnRelate()
property TagOverrideData [ MultiDimensional ];
array representation of tag override data found in APIANNOTATIONS XData block, if any. See BuildProxy() for details.
Property methods: TagOverrideDataDisplayToLogical(), TagOverrideDataGet(), TagOverrideDataIsValid(), TagOverrideDataLogicalToDisplay(), TagOverrideDataLogicalToOdbc(), TagOverrideDataNormalize(), TagOverrideDataSet()

Methods

classmethod BuildProxy(pModuleName As %String, pClassName As %Dictionary.Classname, pListOfModulesDependedOn As %Library.List, Output pNewProxy As %ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassProxy) as %Status [ Language = objectscript ]
given a class name, populate the class proxy with annotations etc.
method CalculatedMembersGet() as %Collection.AbstractListOfObj [ Language = objectscript ]
method CalculatedNonModuleSuperclassesGet() as %Collection.AbstractListOfObj [ Language = objectscript ]
method CheckExtensionFromSuperclasses(pImmediateSuperclasses As %String, pPrimarySuperChain As %String, pListOfModulesDependedOn As %Library.List) [ Language = objectscript ]
looks at all the immediate superclasses and checks whether any of them are non-extensible members of other modules, etc.
classmethod DefaultAPITag() as %String [ Language = objectscript ]
method GetFriendlyIdentifier() as %String [ Language = objectscript ]
Inherited description: a text string for identifying things in error messages and whatnot
classmethod GetOwnerClassProxyID(pID As %Integer) as %Integer [ Language = objectscript ]
method HandleClassInheritance(pPrimarySuper As %String) [ Language = objectscript ]

Indices

index (ClassOnly on Name) [Unique];
Index methods: ClassOnlyCheck(), ClassOnlyCheckUnique(), ClassOnlyDelete(), ClassOnlyExists(), ClassOnlyOpen(), ClassOnlySQLCheckUnique(), ClassOnlySQLExists(), ClassOnlySQLFindPKeyByConstraint(), ClassOnlySQLFindRowIDByConstraint()
index (ClassProxyExtentIndex on ) [Extent];
index (ModuleAndClass on Name,ModuleName) [PrimaryKey];
Index methods: ModuleAndClassCheck(), ModuleAndClassCheckUnique(), ModuleAndClassDelete(), ModuleAndClassExists(), ModuleAndClassOpen(), ModuleAndClassSQLCheckUnique(), ModuleAndClassSQLExists(), ModuleAndClassSQLFindPKeyByConstraint(), ModuleAndClassSQLFindRowIDByConstraint()
index (ModuleIndex on ModuleName);
Index methods: ModuleIndexExists()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%ZHSLIB.PackageManager.Developer.Annotation.CosEntity)

^HS.PM.Dev.Annotation.CosEntityD(ID)
=
%%CLASSNAME

Storage Model: Storage (%ZHSLIB.PackageManager.Developer.Annotation.CosEntity.CommentableEntity)

^HS.PM.Dev.Annotation.CosEntityD(ID,"CommentableEntity")
=
Name
CommentBlock
IsAPI
SkipTagInheritance

Storage Model: Storage (%ZHSLIB.PackageManager.Developer.Annotation.CosEntity.ClassProxy)

^HS.PM.Dev.Annotation.CosEntityD(ID,"ClassProxy")
=
ModuleName
Feedback