Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [ContextSearch]
Private  Storage   

class Ens.ContextSearch extends %ZEN.Portal.ContextSearch

Context search methods.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
49


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%ParseContext %RemoveFromSaveSet %Search %SerializeObject
%SetModified %ValidateObject AllBusinessHosts BasicDatatypes
BusinessComponents BusinessMetrics BusinessOperations BusinessPartners
BusinessProcesses BusinessServices CharacterSets ClassPackages
Classes Credentials CustomResource Datatypes
EnterpriseClients EnterpriseMessageSource EnterpriseMessageTarget GetEnsembleNamespaces
InLocale IsComponent ListEnsembleUsers LookupTables
ManagedAlertGroups ManagedAlertSources MessageBankNodes MessageProperties
MonitorCategories MsgSource MsgTarget Packages
ProductionAlertGroups ProductionCategories ProductionItems Properties
RecordMaps RoutingRuleNames RuleNames SDSGetHostClasses
SDSGetProductionItems SDSGetProductions SDSGetSettings SSLConfigs
ScheduleNames SchemaCategories SearchTableClasses SearchTableProperties
SubclassOf TCPLocalInterfaces VDocClasses WorkflowOperations
WorkflowRoles WorkflowUsers getDisplayList


Methods

• classmethod AllBusinessHosts(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod BasicDatatypes(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Execute a search for a basic subset of InterSystems IRIS datatypes
• classmethod BusinessComponents(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod BusinessMetrics(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod BusinessOperations(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod BusinessPartners(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of Business Partner profiles
• classmethod BusinessProcesses(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod BusinessServices(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod CharacterSets(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod ClassPackages(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
List the names of all class packages in the hierarchy. Exclude the InterSystems internal packages csp, CSPX, Ens, EnsLib, EnsPortal, HS, and any packages whose name starts with "%".
• classmethod Credentials(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of Credential definitions
• classmethod Datatypes(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "")
Execute a search for user-defined datatypes and a basic subset of InterSystems IRIS datatypes
• classmethod EnterpriseClients(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of known Enterprise Clients
• classmethod EnterpriseMessageSource(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method: EnterpriseMessageSource.
Execute a search for all message sources in the Message Bank.
• classmethod EnterpriseMessageTarget(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method: EnterpriseMessageTarget.
Execute a search for all message targets in the Message Bank.
• classmethod GetEnsembleNamespaces(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Context Search to get all the namespaces
• classmethod InLocale(pName As %String, pTabs As %List) as %Boolean
• classmethod IsComponent(pClass As %String) as %Boolean
Given a business process class name, return if it is a component
• classmethod ListEnsembleUsers(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod LookupTables(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Context Search to get Lookup Table names and return prefixed with @
pParms("tablePrefix") can be set to limit tables returns based on starting characters.
List only returned for users with privilege %Ens_LookupTables:READ
• classmethod ManagedAlertGroups(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod ManagedAlertSources(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod MessageBankNodes(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod MessageProperties(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Display all the properties of a given object, including deep objects. The method accepts the following parameters:
  • shallow = 0|1 -- only retrieve properties reflected in the class description. This invokes ..Properties(). The default is 0.
  • class -- the name of the class to retrieve properties for.
  • sqlFields = 0|1 -- only retrieve properties which have an SQL projection (i.e. are stored or SQLComputed).
• classmethod MonitorCategories(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod MsgSource(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method: MsgSource.
Execute a search for all Config Item names that are message sources.
• classmethod MsgTarget(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method: MsgTarget.
Execute a search for all Config Item names that are message targets.
• classmethod ProductionAlertGroups(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Context Search to get all the AlertGroups defined for config items in a specified production.
• classmethod ProductionCategories(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod ProductionItems(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod RecordMaps(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of Record Map definitions
• classmethod RoutingRuleNames(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod RuleNames(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod SDSGetHostClasses(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to get all host class names for the System Default Settings page.
• classmethod SDSGetProductionItems(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to get all items of a single Production or of all Productions for the System Default Settings page.
• classmethod SDSGetProductions(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to get Productions for the System Default Settings page.
• classmethod SDSGetSettings(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to get all setting names for the System Default Settings page.
• classmethod SSLConfigs(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of SSL/TLS Configurations
• classmethod ScheduleNames(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of named schedule strings
• classmethod SchemaCategories(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod SearchTableClasses(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod SearchTableProperties(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to list the properties for a SearchTable specified in the "searchTable" parameter.
• classmethod SubclassOf(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
This is a simpler method than the similar-purposed Classes() method in %ZEN.Portal.ContextSearch. This method provides more accurate results in simpler cases. It is useful when you just want to list all subclasses. Let the value of the "class" parameter be the name of the superclass whose subclasses you want to list.
• classmethod TCPLocalInterfaces(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Get a list of link-local interface addresses
• classmethod VDocClasses(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
Search method to list Virtual Document classes based on the EnumerateVDocs query in Ens.VDoc.Interface. The search method accepts three parameters:
  • segmented = 0|1 -- if 1, display classes which extend EnsLib.EDI.Segmented. Default is 0.
  • abstract = 0|1 -- if 1, display abstract classes. Default is 0.
  • persistent = 0|1 -- if 1, require the class to be persistent. Default is 1.
• classmethod WorkflowOperations(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod WorkflowRoles(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod WorkflowUsers(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status
• classmethod getDisplayList(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String = "") as %Status


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.