class Ens.VDoc.Utils
extends %RegisteredObject
This class contains a number of utility methods used to expose metadata of virtual document classes
• classmethod EnumerateDocContentsClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateDocContentsExecute(ByRef qHandle As %Binary, Class As %String, Mode As %String, DocType As %String, Level As %Integer, DotAbbrevs As %Boolean = 1, ForceObjectProps As %Boolean, pIncludeBase As %Boolean)
as %Status
• classmethod EnumerateDocContentsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• classmethod EnumerateDocTypesClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateDocTypesExecute(ByRef qHandle As %Binary, Class As %String, Category As %String, IncludeBase As %Boolean)
as %Status
• classmethod EnumerateDocTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• classmethod EnumerateVDocSchemasClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateVDocSchemasExecute(ByRef qHandle As %Binary, VDocClass As %String = "", Std As %String = "")
as %Status
• classmethod EnumerateVDocSchemasFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• classmethod GetGetCode(pCode As %String, pLanguage As %String, pCheckEmptyAsNull As %Boolean = 0, pSC As %String = "tSCGet")
as %String
Return the document interface expression for an expression
For virtual documents using GetValueAt() the default is to set a status output variable named tSCGet,
but if pSC is null, no status output variable will be included
• classmethod GetIndexedInfoArray(Output pArray, pClass As %String, pMode As %String, pDocType As %String, pMaxLevel As %Integer)
as %Status
Get the array of property information for the given virtual document target/source class.
This array is indexed by property name.
• classmethod GetInfoArray(Output pArray, pClass As %String = "", pMode As %String = "source", pDocType As %String = "", pMaxLevel As %Integer = 0, pForceObjectProps As %Boolean = 0, pNodeAddr As %String = "", pIncludeBase As %Boolean)
as %Status
Get one node from a (virtual) array of property information for the given target/source class.
This node is addressed by a comma-separated list of descending ordinal positions.
• classmethod GetNextCode(Output pCode, Output pComplete As %Boolean, pProperty As %String, pKey As %String, pLanguage As %String, pSC As %String = "tSCTrans")
as %Status
Return the document interface iterator next code
• classmethod GetSetCode(Output pCode As %String, Output pComplete As %Boolean, pProperty As %String, pValue As %String, pAction As %String, pKey As %String, pLanguage As %String, pSameClass As %Boolean = 1, pAddDTLParams As %Boolean = 0)
as %Status
Return the Set code expression for an assign element
• classmethod IsVirtualDocument(pClass As %String)
as %Boolean
Find out if a given class is a Virtual Document (i.e., supports the Ens.VDoc.Interface)
• classmethod isPseudoVDocBatchProperty(pObject)
as %Boolean
• classmethod isSingleVirtualProperty(pExpression, pObject, pProperty)
as %Boolean
• classmethod quoteDocumentPath(pCode As %String, pLangBasic As %Boolean = 0)
as %String
• query EnumerateDocContents(Class As %String, Mode As %String = "source", DocType As %String = "", Level As %Integer = 0, DotAbbrevs As %Boolean = 1, ForceObjectProps As %Boolean = 0, pIncludeBase As %Boolean = 0)
Selects
Property As %String, Type As %String
This query returns information for the DTL editor.
For a given class and document type, it returns a list
of properties.
Mode is either "target" or "source".
• query EnumerateDocTypes(Class As %String, Category As %String = "", IncludeBase As %Boolean = 0)
Selects
Type As %String
This query returns information for the DTL editor.
For the given class, it returns a set of document types.
• query EnumerateVDocSchemas(VDocClass As %String = "", Std As %String = "")
Selects
VDocClass As %String, Category As %String, IsStd As %Boolean, Family As %String, SchemaDocExt As %String, Base As %String
Returns a list of document type schema categories for the given virtual document class, or for all virtual document classes that have associated schemas.
The Std parameter can be used to restrict the list.
If Std is:
0 - return only standard categories
+ - return only user-defined categories
empty - return all categories
a partial category name - return only categories starting with the given category name part
other - return nothing
