Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

EnsPortal.ServiceRegistry.Dialog.ExtendedSearch

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.

Properties

property Registry as %ZEN.Datatype.string (ZENURL = "REGISTRY") [ Final ];
Property methods: RegistryDisplayToLogical(), RegistryGet(), RegistryIsValid(), RegistryLogicalToDisplay(), RegistryLogicalToOdbc(), RegistryNormalize(), RegistrySet()
property RetValue as %ArrayOfObjects [ InitialExpression = $$$NULLOREF ];
Property methods: RetValueGet(), RetValueGetObject(), RetValueGetObjectId(), RetValueGetSwizzled(), RetValueIsEmpty(), RetValueIsValid(), RetValueNewObject(), RetValueSet(), RetValueSetObject(), RetValueSetObjectId(), RetValueUnSwizzle()
property key as %Integer (ZENURL = "KEY");
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyNormalize(), keySet(), keyXSDToLogical()
property tipAddCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Add a condition") ];
Property methods: tipAddConditionDisplayToLogical(), tipAddConditionGet(), tipAddConditionIsValid(), tipAddConditionLogicalToDisplay(), tipAddConditionLogicalToOdbc(), tipAddConditionNormalize(), tipAddConditionSet()
property tipRemoveCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Remove this condition") ];
Property methods: tipRemoveConditionDisplayToLogical(), tipRemoveConditionGet(), tipRemoveConditionIsValid(), tipRemoveConditionLogicalToDisplay(), tipRemoveConditionLogicalToOdbc(), tipRemoveConditionNormalize(), tipRemoveConditionSet()

Methods

method %OnAfterCreatePage() as %Status
Inherited description: 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 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.
clientmethod addCondition(draw) [ Language = javascript ]
Add a Condition to the current Term. draw indicates whether the conditions should be redrawn.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page, provided resize handling is not disabled.
clientmethod 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.
clientmethod 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.
clientmethod drawConditions() [ Language = javascript ]
Render the current list of conditions on the client.
clientmethod 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.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod 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.
clientmethod 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.
clientmethod hideAllOptions(checkVisible) [ Language = javascript ]
Helper method to ensure that all selector modals are hidden.
clientmethod hideOptions(inputName) [ Language = javascript ]
Hide the selector modal for a specified input control.
clientmethod 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.
clientmethod ondialogStart() [ Language = javascript ]
Ensure that we have been opened from the Message Viewer.
clientmethod onresizeHandler() [ Language = javascript ]
Ensure that we hide any modal divs to avoid nasty geometry problems.
clientmethod pickOption(inputName, pickedValue) [ Language = javascript ]
Callback to ensure that we pick up the chosen value and hide the modal div containing the options.
clientmethod removeCondition(index) [ Language = javascript ]
Remove a condition from the local conditions list.
clientmethod 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab