Home > Class Reference > ENSLIB namespace > %ZEN.Dialog.searchDialog

%ZEN.Dialog.searchDialog

class %ZEN.Dialog.searchDialog extends %ZEN.Dialog.standardDialog

This utility dialog window displays a search page. The results of an SQL query are displayed and the user can make a selection.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter APPLYBUTTON = 0;
No Apply button.
parameter AUTONS = 1;
Inherited description: If true, auto-switch namespace to whatever $NAMESPACE is passed in.
parameter DOMAIN = %ZEN;
Inherited description: Localization domain

Properties (Including Private)

property paramCount as %ZEN.Datatype.integer (ZENSETTING = 0);
Number of parameters in the current query.
Property methods: paramCountDisplayToLogical(), paramCountGet(), paramCountIsValid(), paramCountLogicalToDisplay(), paramCountLogicalToOdbc(), paramCountNormalize(), paramCountSet()
property paramNames as %ZEN.Datatype.csv (ZENURL = "paramNames");
List names to display for parameters in the search form.
Property methods: paramNamesDisplayToLogical(), paramNamesGet(), paramNamesIsValid(), paramNamesLogicalToDisplay(), paramNamesLogicalToOdbc(), paramNamesNormalize(), paramNamesSet()
property query as %ZEN.Datatype.sql;
SQL statement used to populate the search form. This cannot be passed in via URL; instead applications should subclass this component and provide the search query using server-side logic.
Property methods: queryDisplayToLogical(), queryGet(), queryIsValid(), queryLogicalToDisplay(), queryLogicalToOdbc(), queryNormalize(), querySet()

Methods (Including Private)

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
method %OnAfterCreatePage() as %Status
Set up the table pane.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
clientmethod execSearch() [ Language = javascript ]
User has pressed the search button.
clientmethod getDialogValue() [ Language = javascript ]
Return the value that should be returned by this dialog.

Inherited Members

Inherited Properties (Including Private)