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 > ENSLIB namespace > Ens.VDoc.SearchTableGenerator

Ens.VDoc.SearchTableGenerator

class Ens.VDoc.SearchTableGenerator extends %Library.RegisteredObject

Method Inventory (Including Private)

Methods (Including Private)

classmethod DeleteProps(pSearchTableExtentSuperclass As %String) as %Status
classmethod EnumerateSearchPropsClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateSearchPropsExecute(ByRef qHandle As %Binary, Class As %String) as %Status
classmethod EnumerateSearchPropsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod FindClassDefMethod(pClassDef As %Dictionary.CompiledClass, pMethodName As %String) as %Dictionary.CompiledMethod
classmethod FindClassDefParameterVal(pClassDef As %Dictionary.CompiledClass, pParamName As %String) as %String
Helper method for code generators
classmethod FindClassDefProperty(pClassDef As %Dictionary.CompiledClass, pPropName As %String) as %Dictionary.CompiledProperty
classmethod GetExtentSuperclass(pDerivedClass As %String) as %String
classmethod GetExtentSupertable(pDerivedClass As %String) as %String
classmethod ValidateSearchTableProperties(pClassname As %String = "", Output pSearchTableProperties, Output pSearchTableItems) as %Status
This API allows for the (re)generation of Ens.Config.SearchTableProp entries for a specific SearchTable class without requiring a recompile of the class. The class must have been compiled at some point, but a recompilation is not needed for the purposes of validating the SearchSpec XData and ensuring that the corresponding Ens.Config.SearchTableProp objects are present and correctly defined.
classmethod genMethods(pDocClassname As %String, ByRef pProps, ByRef pItems, ByRef pTypeMethods, pSearchTableSuper, ByRef pInsertLabels) as %Status
classmethod getMethods(pDocClassname As %String, Output pProps, Output pItems, Output pTypeMethods) as %Status
classmethod getPropId(pSearchTableClass As %String, pPropName As %String, Output pPropType, Output pStoreNulls, Output pUnselective) as %Integer
Get the PropId for a given property name in given a SearchTable class
classmethod getPropsList(pSearchTableClass As %String, Output pProps) as %Status
Build an array of property definitions given a SearchTable class
classmethod getpropsmethodname(pType As %String) as %String

Queries

query EnumerateSearchProps(Class As %String)
Selects Name As %String, PropId As %String, PropType As %String, IndexType As %String
For a given SearchTable class, it returns a list of the virtual search properties defined by that class and its superclasses.

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window