IRISLIB database
ContextSearch Class Reference

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

Inheritance diagram for ContextSearch:
Collaboration diagram for ContextSearch:

Static Public Member Functions

_.Library.Status Classes (_.Library.String pCaption, pTopResults, pResults, _.Library.String pParms, _.Library.String pSearchKey)
 Search method: Classes. More...
 
_.Library.Status CustomResource (_.Library.String pCaption, pTopResults, pResults, _.Library.String pParms, _.Library.String pSearchKey)
 Search method: CustomResource. More...
 
_.Library.Status Packages (_.Library.String pCaption, pTopResults, pResults, _.Library.String pParms, _.Library.String pSearchKey)
 Search method: Packages. More...
 
_.Library.Status Properties (_.Library.String pCaption, pTopResults, pResults, _.Library.String pParms, _.Library.String pSearchKey)
 Search method: Properties. More...
 

Static Public Attributes

 DOMAIN = None
 Set this to the correct domain.
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Static Private Member Functions

_.Library.Status ParseContext (_.Library.String pContext, _.Library.String pClassName, _.Library.String pMethodName, pParms)
 Parse a context string.
 
_.Library.Status Search (_.Library.String pCaption, pTopResults, pResults, _.Library.String pContext, _.Library.String pSearchKey)
 Perform a search. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Detailed Description

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

Member Function Documentation

◆ Search()

_.Library.Status Search ( _.Library.String  pCaption,
  pTopResults,
  pResults,
_.Library.String  pContext,
_.Library.String  pSearchKey 
)
staticprivate

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)

◆ Classes()

_.Library.Status Classes ( _.Library.String  pCaption,
  pTopResults,
  pResults,
_.Library.String  pParms,
_.Library.String  pSearchKey 
)
static

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.

◆ CustomResource()

_.Library.Status CustomResource ( _.Library.String  pCaption,
  pTopResults,
  pResults,
_.Library.String  pParms,
_.Library.String  pSearchKey 
)
static

Search method: CustomResource.


Execute a search for resources and custom resources.

◆ Packages()

_.Library.Status Packages ( _.Library.String  pCaption,
  pTopResults,
  pResults,
_.Library.String  pParms,
_.Library.String  pSearchKey 
)
static

Search method: Packages.


Execute a package name search.
system = 1|0 show system classes.

◆ Properties()

_.Library.Status Properties ( _.Library.String  pCaption,
  pTopResults,
  pResults,
_.Library.String  pParms,
_.Library.String  pSearchKey 
)
static

Search method: Properties.


Execute a class property search.
Parameters can include:
class = class name