Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.Dialog.SearchCriteria
Private  Storage   


class EnsPortal.Dialog.SearchCriteria extends


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 9 31


This is a Zen Page class. It belongs to the application EnsPortal.Application.

%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children closeOnEnter closeOnEsc
composite containerStyle critDisabled cssLevel
dialogTitle disabled disabledStyle dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle hasButtons
headerClass height hidden hideApplyButton
hideCancelButton hideOKButton hint hintClass
hintStyle id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent propClass propType
showLabel slice studioMode tipAddCondition
tipAddValue tipHelp tipRemoveCondition tipRemoveValue
title tuple useSVG useSoftModals
valign visible width window

%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddToSaveSet
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%DrawTitle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetLinks %GetPageName %GetParameter
%GetValueById %GetValueByName %GetXMLName %IsA
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage
%OnCreateApplication %OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv
%OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion ConvertParameter
Decrypt Encrypt EscapeHTML EscapeURL
GetHelpURL GetHyperEventResources GetOptions HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addCondition addPopupSuffix
adjustSize btnApply btnOK buildConditionArray
cancelPopup changeClass changeCondition changeEnabled
changePropType checkEdit childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS ctrlKeyDown
deleteComponent dialogApply dialogCancel dialogFinish
dialogTitleGet disableButtons dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawClassSelector drawConditions
drawSelector dropHandler dropStartHandler endModal
exposeComponent findElement fireOnResizeEvent fireOnUnloadEvent
fireOnUpdateEvent firePopupAction getChildIndex getComponent
getComponentById getDialogValue getEnclosingDiv getHidden
getHintElement getJoins getLabelElement getOpener
getOperators getProperty getSettings getType
gotoPage hideAllOptions hideOptions inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondialogCancel ondialogFinish ondialogStart ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler pickOption popupActionHandler refreshContents
removeChild removeCondition removePopupSuffix render
renderContents renderSVG setComponentId setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
showFinder showHelp showOptions startKeepAlive
startModal startProgressBar stopKeepAlive stopProgressBar



• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter RESOURCE = "%Ens_MessageHeader:USE";
User needs USE permissions on the %Ens_MessageHeader resource to view this page.


• property critDisabled as %ZEN.Datatype.boolean(ZENURL="DISABLED") [ InitialExpression = 0 ];
• property headerClass as %ZEN.Datatype.className [ InitialExpression = "Ens.MessageHeader" ];
• property propClass as %ZEN.Datatype.className(ZENURL="PROPCLASS");
• property propType as %ZEN.Datatype.string(VALUELIST=",Header,Body,SearchTable,VDocSegment,VDocPath,OR",ZENURL="PROPTYPE") [ InitialExpression = "Header" ];
• property tipAddCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Add a condition") ];
• property tipAddValue as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Add a display value") ];
• property tipHelp as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Display message search help") ];
• property tipRemoveCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Remove this condition") ];
• property tipRemoveValue as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Remove this value") ];


• method %OnAfterCreatePage() as %Status
Avoid writing out the session cookie if we are in a Studio session.
• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog.
• classmethod GetHelpURL() as %String [ ZenMethod ]
Return a link to the search filter documentation. We use Link to ensure we include the server prefix.
• classmethod GetOptions(pContextSearch As %String, pParms As %ZEN.proxyObject, pTopOptions As %ZEN.proxyObject, pOptions As %ZEN.proxyObject) as %String [ ZenMethod ]
Wrapper method around %ZEN.Portal.ContextSearch which ensures that we avoid using search keys. It returns the results to the client in %ZEN.proxyObject instances.
• method addCondition(draw, displayOnly) [ Language = javascript ]
Add a Condition to the current Term. draw indicates whether the conditions should be redrawn.
• method adjustSize() [ Language = javascript ]
Adjust size and position of components on this page, provided resize handling is not disabled.
• method buildConditionArray() [ Language = javascript ]
Rebuild the local Condition array based on the Conditions in the Message Viewer window. Note that the local array contains clones of the parent data to ensure that discarded changes don't affect the original values.
• method changeClass(newVal) [ Language = javascript ]
Method to reinitialise the conditions when the class type is changed. newVal is the new class name.
• method changeCondition(index, property, newVal) [ Language = javascript ]
Utility method to change properties of the local conditions. index is the index of the condition; property is the name of the property; newVal is the new value.
• method changeEnabled(newVal) [ Language = javascript ]
• method changePropType(newVal) [ Language = javascript ]
Method to reinitialize the local conditions list and display when the property type is changed. newVal is the new property type.
• method drawClassSelector() [ Language = javascript ]
Helper method to draw the class selection component, which is generally an "HTML-selector", but may also be a disabled text box when we are performing a Header search.
• method drawConditions() [ Language = javascript ]
Render the current list of conditions on the client.
• method drawSelector(htmlArray, inputId, value, onchange, size, title) [ Language = javascript ]
Helper method to create an HTML-based selector component which behaves much like the core %ZEN.Portal.selector component.
• method getDialogValue() [ Language = javascript ]
Insert the criteria into the parent's Filter object.
• method getJoins(htmlFormat, selected) [ Language = javascript ]
Return the supported joins in an array. The htmlFormat flag indicates whether the values should be returned as an array of <option> elements. selected contains the value of the currently selected value, if any.
• method getOperators(htmlFormat, selected) [ Language = javascript ]
Return the supported operators in an array. The htmlFormat flag indicates whether the values should be returned as an array of <option> elements. selected contains the value of the currently selected value, if any.
• method hideAllOptions(checkVisible) [ Language = javascript ]
Helper method to ensure that all selector modals are hidden.
• method hideOptions(inputName) [ Language = javascript ]
Hide the selector modal for a specified input control.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.
• method ondialogFinish(action) [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled. Set a flag to indicate that the changes should be applied.
• method ondialogStart() [ Language = javascript ]
Ensure that we have been opened from the Message Viewer.
• method onresizeHandler() [ Language = javascript ]
Ensure that we hide any modal divs to avoid nasty geometry problems.
• method onunloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
• method pickOption(inputName, pickedValue) [ Language = javascript ]
Callback to ensure that we pick up the chosen value and hide the modal div containing the options.
• method removeCondition(index) [ Language = javascript ]
Remove a condition from the local conditions list.
• method showFinder(type, position, condition) [ Language = javascript ]
Helper method to load a finder dialog for picking VDoc information. type specifies the property type, which should be either 'VDocPath' or 'VDocSegment'. position indicates whether it is the first or second part of the property. condition is the index of the condition being changed.
• method showHelp() [ Language = javascript ]
Open the search filter documentation in a new window .
• method showOptions(inputName) [ Language = javascript ]
Display the options for a selector based on the name of the input control passed in inputName. This also hides all other visible selector modals, and will hide this control if it was already visible. The method will also check whether we have enough information to fetch the contents. If not, we report an error and return.
• method updateVDocValues(index) [ Language = javascript ]