Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > %ZEN.Portal.ContextSearch
Private  Storage   

%ZEN.Portal.ContextSearch


abstract class %ZEN.Portal.ContextSearch extends
%RegisteredObject

Provides the basic search capabilities for context-based searching within the Portal.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 6


Summary


Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %ParseContext %RemoveFromSaveSet %Search
%SerializeObject %SetModified %ValidateObject Classes
CustomResource Packages Properties

Subclasses
%DeepSee.Component.ContextSearch Ens.ContextSearch Ens.MFT.ContextSearch

Parameters


• parameter DOMAIN = "%ZEN";
Set this to the correct domain.

Methods


• classmethod %ParseContext(pContext As %String, Output pClassName As %String, Output pMethodName As %String, Output pParms) as %Status
Parse a context string.
• final classmethod %Search(Output pCaption As %String, Output pTopResults, Output pResults, pContext As %String, pSearchKey As %String) as %Status
Perform a search. Return a list of results.
pContext is the search context string. This is parsed and the actual search class and method are invoked.
pSearchKey is the value in the search control when the user invoked the search.
pTopResults contains the list of most likely results (if any).
pResults contains the list of all results.
Both arrays take the form:
pResults(n) = result (string)
• classmethod Classes(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String) as %Status
Search method: Classes.
Execute a class name search.
Parameters can include:
super or subclasses = show only classes derived from the specified class.
system = 1|0 show system classes.
internal = 1|0 show internal classes.
hideAbstract = 1|0 hide classes marked as abstract.
classtype = datatype|persistent|serial|stream|view show only classes of the specified type. Default is empty string for all types.
• classmethod CustomResource(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String) as %Status
Search method: CustomResource.
Execute a search for resources and custom resources.
• classmethod Packages(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String) as %Status
Search method: Packages.
Execute a package name search.
system = 1|0 show system classes.
• classmethod Properties(Output pCaption As %String, Output pTopResults, Output pResults, ByRef pParms As %String, pSearchKey As %String) as %Status
Search method: Properties.
Execute a class property search.
Parameters can include:
class = class name