Skip to main content

HS.Doc.Utility.Search

abstract class HS.Doc.Utility.Search

Method Inventory

Methods

classmethod DisplayTarget(tRun) as %Status
classmethod Run(FieldId As %String = "", displayDetail As %Boolean = 0, tRun As %String)
Given a target field, find all the mappings from other data sources to it.

FieldId is an ID value from the HS_Doc_Data.Field table. This ID value uniquely identifies a field in some document type. An ID is used instead of a Path (used in prior versions of this method) because Path values in the HS_Doc_Data.Field table are not unique.

If displayDetail is 1, the Run() method will send detailed informational text to the current output device (e.g. Terminal). When calling the Run() method method to get results for a user interface page, set displayDetail to 0 (the default).

The output argument tRun is an identifier to use as input to any methods that display the results, i.e. UI rendering methods. See HS.Doc.UI.Util and HS.Doc.UI.Mapping.

classmethod SearchTarget(FieldId As %String = "", tRun As %String) as %Status
Given a target field, build a tree from other data sources to it. Go down as many levels of mapping as required, avoiding any full circles.

FieldId is an ID value from the HS_Doc_Data.Field table. This ID value uniquely identifies a field in some document type. An ID is used instead of a Path (used in prior versions of this method) because Path values in the HS_Doc_Data.Field table are not unique.

The output argument tRun is an identifier to use as input to any methods that display the results.

classmethod getLinkInfo(pSourceId As %String, pTargetId As %String, pMappingName As %String, pComment As %String) as %Status
classmethod showComment(pComment As %String, pAllignment As %String)
classmethod showField(tFieldId As %String) as %Status
FeedbackOpens in a new tab