Home > Class Reference > ENSLIB namespace > EnsPortal.Template.filteredViewer

EnsPortal.Template.filteredViewer

abstract class EnsPortal.Template.filteredViewer extends EnsPortal.Template.viewerPage

Parameters

parameter SessionSubscripts = SavedSearch;
Comma separated list of subscripts to use in the %session object for saved searches.
parameter SessionTraceColumn = ID;
Name of column to use for Session ID in links. This is primarily for the MessageBank, which displays the client session but links to the banked session.

Properties

property assistantClass as %String [ InitialExpression = ..GetAssistantClass() , ReadOnly ];
Name of the Assistant class to use.
Property methods: assistantClassDisplayToLogical(), assistantClassGet(), assistantClassIsValid(), assistantClassLogicalToDisplay(), assistantClassLogicalToOdbc(), assistantClassNormalize()
property canResend as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Flag to indicate whether a user may resend messages. Sub classes to implement based on resource required.
Property methods: canResendDisplayToLogical(), canResendGet(), canResendIsValid(), canResendLogicalToDisplay(), canResendLogicalToOdbc(), canResendLogicalToXSD(), canResendNormalize(), canResendSet(), canResendXSDToLogical()
property criteriaDialog as %String [ InitialExpression = "EnsPortal.Dialog.SearchCriteria.zen" , ReadOnly ];
URL of dialog window to use for editing Search Criteria.
Property methods: criteriaDialogDisplayToLogical(), criteriaDialogGet(), criteriaDialogIsValid(), criteriaDialogLogicalToDisplay(), criteriaDialogLogicalToOdbc(), criteriaDialogNormalize()
property currentSearch as %ZEN.Datatype.string (ZENURL = "SAVEDSEARCH");
Name of the current saved search. Should be empty if no saved search is selected. Users can bookmark saved searches by using making use of the SAVEDSEARCH parameter in the URL.
Property methods: currentSearchDisplayToLogical(), currentSearchGet(), currentSearchIsValid(), currentSearchLogicalToDisplay(), currentSearchLogicalToOdbc(), currentSearchNormalize(), currentSearchSet()
property filterClass as %String [ InitialExpression = "EnsPortal.MsgFilter.Filter" , ReadOnly ];
Name of Filter class to use for filtering searches.
Property methods: filterClassDisplayToLogical(), filterClassGet(), filterClassIsValid(), filterClassLogicalToDisplay(), filterClassLogicalToOdbc(), filterClassNormalize()
property headerClass as %String [ InitialExpression = "Ens.MessageHeader" , ReadOnly ];
Header class to use for queries and display.
Property methods: headerClassDisplayToLogical(), headerClassGet(), headerClassIsValid(), headerClassLogicalToDisplay(), headerClassLogicalToOdbc(), headerClassNormalize()
property ignoreSearchWarnings as %Boolean [ InitialExpression = 1 ];
Flag to indicate whether the server should check for search warnings. This is set to 1 to avoid issues when first loading the query as part of the page load, and should then be set to 0 for most subsequent searches. It should only be set to 1 when users have read a warning and have chosen to execute a possibly problematic query.
Property methods: ignoreSearchWarningsDisplayToLogical(), ignoreSearchWarningsGet(), ignoreSearchWarningsIsValid(), ignoreSearchWarningsLogicalToDisplay(), ignoreSearchWarningsLogicalToXSD(), ignoreSearchWarningsNormalize(), ignoreSearchWarningsSet(), ignoreSearchWarningsXSDToLogical()
property msgViewTrace as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace") ];
Property methods: msgViewTraceDisplayToLogical(), msgViewTraceGet(), msgViewTraceHoverDisplayToLogical(), msgViewTraceHoverGet(), msgViewTraceHoverIsValid(), msgViewTraceHoverLogicalToDisplay(), msgViewTraceHoverLogicalToOdbc(), msgViewTraceHoverNormalize(), msgViewTraceHoverSet(), msgViewTraceIsValid(), msgViewTraceLogicalToDisplay(), msgViewTraceLogicalToOdbc(), msgViewTraceNormalize(), msgViewTraceSet()
property msgViewTraceHover as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace including Events and message contents") ];
Property methods: msgViewTraceHoverDisplayToLogical(), msgViewTraceHoverGet(), msgViewTraceHoverIsValid(), msgViewTraceHoverLogicalToDisplay(), msgViewTraceHoverLogicalToOdbc(), msgViewTraceHoverNormalize(), msgViewTraceHoverSet()
property resendPage as %String [ InitialExpression = "EnsPortal.MessageResend.zen" ];
URL of resend page.
Property methods: resendPageDisplayToLogical(), resendPageGet(), resendPageIsValid(), resendPageLogicalToDisplay(), resendPageLogicalToOdbc(), resendPageNormalize(), resendPageSet()
property savedSearchClass as %String [ InitialExpression = "EnsPortal.MsgFilter.SavedSearch" , ReadOnly ];
Name of SavedSearch class to use for saving searches.
Property methods: savedSearchClassDisplayToLogical(), savedSearchClassGet(), savedSearchClassIsValid(), savedSearchClassLogicalToDisplay(), savedSearchClassLogicalToOdbc(), savedSearchClassNormalize()
property searchWarnings as list of %String;
List of warnings regarding the user's current search criteria.
Property methods: searchWarningsBuildValueArray(), searchWarningsCollectionToDisplay(), searchWarningsCollectionToOdbc(), searchWarningsDisplayToCollection(), searchWarningsDisplayToLogical(), searchWarningsGet(), searchWarningsGetObject(), searchWarningsGetObjectId(), searchWarningsGetSwizzled(), searchWarningsIsValid(), searchWarningsLogicalToDisplay(), searchWarningsLogicalToOdbc(), searchWarningsNormalize(), searchWarningsOdbcToCollection(), searchWarningsSet(), searchWarningsSetObject(), searchWarningsSetObjectId()
property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
Property methods: sessionLinkTitleDisplayToLogical(), sessionLinkTitleGet(), sessionLinkTitleIsValid(), sessionLinkTitleLogicalToDisplay(), sessionLinkTitleLogicalToOdbc(), sessionLinkTitleNormalize(), sessionLinkTitleSet()
property tipAddCriterion as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add Criterion") ];
Property methods: tipAddCriterionDisplayToLogical(), tipAddCriterionGet(), tipAddCriterionIsValid(), tipAddCriterionLogicalToDisplay(), tipAddCriterionLogicalToOdbc(), tipAddCriterionNormalize(), tipAddCriterionSet(), tipAddCriterionTitleDisplayToLogical(), tipAddCriterionTitleGet(), tipAddCriterionTitleIsValid(), tipAddCriterionTitleLogicalToDisplay(), tipAddCriterionTitleLogicalToOdbc(), tipAddCriterionTitleNormalize(), tipAddCriterionTitleSet()
property tipAddCriterionTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add a new criterion") ];
Property methods: tipAddCriterionTitleDisplayToLogical(), tipAddCriterionTitleGet(), tipAddCriterionTitleIsValid(), tipAddCriterionTitleLogicalToDisplay(), tipAddCriterionTitleLogicalToOdbc(), tipAddCriterionTitleNormalize(), tipAddCriterionTitleSet()
property tipAddOR as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add OR") ];
Property methods: tipAddORDisplayToLogical(), tipAddORGet(), tipAddORIsValid(), tipAddORLogicalToDisplay(), tipAddORLogicalToOdbc(), tipAddORNormalize(), tipAddORSet(), tipAddORTitleDisplayToLogical(), tipAddORTitleGet(), tipAddORTitleIsValid(), tipAddORTitleLogicalToDisplay(), tipAddORTitleLogicalToOdbc(), tipAddORTitleNormalize(), tipAddORTitleSet()
property tipAddORTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add an OR condition") ];
Property methods: tipAddORTitleDisplayToLogical(), tipAddORTitleGet(), tipAddORTitleIsValid(), tipAddORTitleLogicalToDisplay(), tipAddORTitleLogicalToOdbc(), tipAddORTitleNormalize(), tipAddORTitleSet()
property tipDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
Property methods: tipDeleteDisplayToLogical(), tipDeleteGet(), tipDeleteIsValid(), tipDeleteLogicalToDisplay(), tipDeleteLogicalToOdbc(), tipDeleteNormalize(), tipDeleteSet()
property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save") ];
Property methods: tipSaveAsDisplayToLogical(), tipSaveAsGet(), tipSaveAsIsValid(), tipSaveAsLogicalToDisplay(), tipSaveAsLogicalToOdbc(), tipSaveAsNormalize(), tipSaveAsSet(), tipSaveDisplayToLogical(), tipSaveGet(), tipSaveIsValid(), tipSaveLogicalToDisplay(), tipSaveLogicalToOdbc(), tipSaveNormalize(), tipSaveSet()
property tipSaveAs as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save As") ];
Property methods: tipSaveAsDisplayToLogical(), tipSaveAsGet(), tipSaveAsIsValid(), tipSaveAsLogicalToDisplay(), tipSaveAsLogicalToOdbc(), tipSaveAsNormalize(), tipSaveAsSet()

Methods

clientmethod Condition(joinOp, prop, op, opVal, displayOnly, term) [ Language = javascript ]
Client-side constructor for EnsPortal.MsgFilter.Condition object.
method CreateResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet [ Language = objectscript ]
Create and execute the result set used to drive the results table. Note that ignoreSearchWarnings controls whether the warnings in searchWarnings should be displayed to the user or ignored.
method DoSearchDelete(pSearchName As %String) as %Status [ Language = objectscript, ZenMethod ]
Server side method to actually delete a named search.
method DoSearchSave(pSearchName As %String, pIsNew As %Boolean = 0) as %String [ Language = objectscript, ZenMethod ]
Server side method to actually save a named search.
method DrawBodyInfo(pHeaderID As %String) as %Status [ Language = objectscript ]
Write out contents of body details panel. pHeaderID is the message id.
method DrawDetailsContent(pID As %String) as %Status [ Language = objectscript ]
Write out contents of details panel. pID is the message id.
Write out the links to show the full contents of a message.
method DrawSessionCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Server-side method to write out the content for the SessionId cells. The main purpose is to ensure that links to the Visual Trace diagram are only included for events which occurred as part of a session.
clientmethod Filter() [ Language = javascript ]
Client-side constructor for Filter object.
classmethod GetAssistantClass() as %String [ Language = objectscript ]
classmethod GetQueryHistory(ByRef pParms, Output pMetaData, Output pData) as %Status [ Language = objectscript ]
method GetSavedSearch() as %String [ Language = objectscript ]
Get the current saved search
method InitSearchCriteria() as %Status [ Language = objectscript ]
Initialise the search criteria for the page.
method LoadFilter(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
Load Filter object from the session, or from a saved search if requested.
classmethod SaveResendIDs(idString As %String) as %String [ Language = objectscript, ZenMethod ]
Save ID values for Resend.
method SetSavedSearch(pSearchName As %String = "") as %Status [ Language = objectscript ]
method SetSearchCriteria() as %String [ Language = objectscript, ZenMethod ]
method SubmitFilter(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, ByRef pObject As %RegisteredObject, Output pResponse As %RegisteredObject) as %Status [ Language = objectscript ]
Send the Filter to the server.
clientmethod Term(type, sourceClass, conditions) [ Language = javascript ]
Client-side constructor for EnsPortal.MsgFilter.Term object.
clientmethod addCriterion() [ Language = javascript ]
Add a criterion and open the Search Criteria editor for the new object.
clientmethod addOR() [ Language = javascript ]
Add an OR criterion.
clientmethod checkSearchWarnings() [ Language = javascript ]
Check whether any warnings are present after trying to execute a search.
clientmethod clone(object) [ Language = javascript ]
Helper method to allow Search Criteria dialog to create clones of existing Term and Condition objects.
clientmethod createArray() [ Language = javascript ]
Helper method to create a new Array object. This is primarily required by the Advanced Search popups -- IE is unhappy about directly invoking constructors on the window.opener object.
clientmethod createCondition(joinOp, prop, op, opVal, displayOnly, term) [ Language = javascript ]
Helper method to create a new Condition object. This is primarily required by the Advanced Search popups -- IE is unhappy about directly invoking constructors on the window.opener object.
clientmethod deleteSearch(searchName) [ Language = javascript ]
Delete an existing saved search.
clientmethod doExport() [ Language = javascript ]
clientmethod doResend() [ Language = javascript ]
clientmethod drawDetails(messageId) [ Language = javascript ]
Update the details for a selected message.
clientmethod drawExtendedCriteria() [ Language = javascript ]
Client-side method to render the extended criteria expando.
clientmethod editCriterion(index) [ Language = javascript ]
Open the SearchCriteria popup for a criterion.
clientmethod getFilter() [ Language = javascript ]
Client accessor for the Filter current object.
clientmethod getResendURL(key, useFilter) as %String [ Language = javascript ]
Use current values of the search criteria and/or selected values to create a URL for the message resend page.
clientmethod layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane. This is primarily due to IE as it shrinks the contents div without this intervention. The function only adjusts the size of the tab group is not hidden.
clientmethod loadSearch(searchName, run) [ Language = javascript ]
Load a named search from the server.
clientmethod onAfterSearch() [ Language = javascript ]
Make sure we check for warnings and update the filter from the server after a search is executed.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
clientmethod onSearchHandler() [ Language = javascript ]
Notify subclass that a search is being executed.
clientmethod onSelectItem() [ Language = javascript ]
Callback to indicate the user clicked on an item. Here we simply make sure that the tab content is up to date.
clientmethod onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
clientmethod onTraceSVGLoad() [ Language = javascript ]
Callback from the Trace SVG onSVGLoad() callback. The callback is used to ensure that we have the loaded SVG diagram available before we attempt to resize the diagram or highlight the currently selected message.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. The primary purposes of this function are to ensure that the details pane is sized correctly based on whether the tab group is hidden, and to correctly update the expander text and the contents of the tab group.
clientmethod onloadHandler() [ Language = javascript ]
Ensure that tab behaviour is initialised correctly.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: 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).
clientmethod removeCriterion(index) [ Language = javascript ]
Remove a criterion from the page.
clientmethod saveSearch(searchName, isNew) [ Language = javascript ]
Save the current search criteria to the server.
clientmethod scaleSVGTrace() [ Language = javascript ]
Correctly resize the SVG trace diagram to fit into the current SVG frame size.
clientmethod searchIfValidPageSize(pageSize) [ Language = javascript ]
clientmethod shiftTerm(index, direction) [ Language = javascript ]
Shift the Term at index one position forward or back in the array, with direction being specified as either 'up' or 'down'.
clientmethod showFullContent(showRaw) [ Language = javascript ]
clientmethod showQuery() [ Language = javascript ]
Inherited description: Show text of most recent query.
clientmethod submitFilterUpdate() [ Language = javascript ]
Send the current Filter to the server so it can be saved.
clientmethod toggleCriterion(index, enabled) [ Language = javascript ]
clientmethod toggleSaveAs(show) [ Language = javascript ]
Toggle the display of the "Save As" controls and the list controls.
clientmethod updateFilterFromForm(updateSearchCriteria) [ Language = javascript ]
Update the current Filter based on the form's contents. Extended criteria are saved separately.
clientmethod updateFormFromFilter() [ Language = javascript ]
Update the form on the page based on an updated Filter object.
clientmethod updateSearchState(submitUpdate) [ Language = javascript ]
Wrapper method to ensure the client state correctly reflects the current criteria, including marking the current search as NOT a saved one.

Inherited Methods

%AddCSPShareHyperevents() %SetModified() fireOnUpdateEvent()
%AddChild() %SetValueById() firePopupAction()
%AddChildAfter() %SetValueByName() getChildIndex()
%AddChildBefore() %SetValuesByName() getComponent()
%AddComponent() %StartScript() getComponentById()
%AddEnsExceptionHandler() %ValidateObject() getContentAreaHeight()
%AddImportedComponents() %ZENVersion() getEnclosingDiv()
%AddLocatorLinks() BuildMenu() getHidden()
%AddToSaveSet() CheckAllBlanks() getHintElement()
%ApplyURLParms() CheckContextLinks() getLabelElement()
%Attr() CheckEnterpriseManager() getNextData()
%BindExport() ConvertParameter() getOpener()
%ClassIsLatestVersion() Decrypt() getPageTitle()
%ClassName() DoLogout() getProperty()
%ConstructClone() DrawLocator() getResultsTable()
%DispatchClassMethod() DrawRibbon() getSearchForm()
%DispatchGetModified() DrawTitle() getSettings()
%DispatchGetProperty() Encrypt() getTitleAreaHeight()
%DispatchMethod() EscapeHTML() getType()
%DispatchSetModified() EscapeURL() goHome()
%DispatchSetMultidimProperty() EvalResult() goMenu()
%DispatchSetProperty() GetCSPURL() gotoNamespace()
%DrawAutoLogout() GetColumnsAndFrom() gotoPage()
%DrawClassDefinitions() GetContextLinks() hideCommandButton()
%DrawComponentHTML() GetDocURL() inResizeLoop()