Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsPortal.Template.filteredViewer
Private  Storage   

EnsPortal.Template.filteredViewer


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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 23 58


Summary


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

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode HelpAddress
ISREADONLY LocatorHeader ParentURL SVGClassList
StdTitle UserSVGPackageList VirtualKey aboutPage
align assistantClass aux backgroundTimerInterval
canEdit canResend cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle criteriaDialog cssLevel
currSortMode currStep currViewMode currentPage
currentPageStart currentSearch designMode detailsHidden
detailsWidth disabled dragAndDrop dragEnabled
dropEnabled dynamic enableAutoRefresh enclosingClass
enclosingStyle error filterClass groupClass
groupStyle headerClass height hidden
hideDetailsMsg hideSearchMsg hint hintClass
hintStyle home homePage id
ignoreSearchWarnings inFirstLoad index inlineSVG
isDefaultFilter isFirstPage isLastPage isPopup
isSoftModal keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle lastModalIndex
layout lblDetails lblTitle limitPopups
msgCloseDetail msgNotPermitted msgViewTrace msgViewTraceHover
name nextIndex onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onoverlay onrefresh onshow onupdate
overlayMode pageId pageModified pageNumberId
pageSizeId parent popupParent queryAtEnd
renderFlag resendPage resultsTableId savedSearchClass
searchCriteria searchJob searchKey searchQuery
searchWarnings selectedId sessionLinkTitle showDetailsMsg
showLabel showSearchMsg slice tablePaneUsesSQLAttrib
tempPortalNode tipAddCriterion tipAddCriterionTitle tipAddOR
tipAddORTitle tipDelete tipSave tipSaveAs
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddLocatorLinks %AddToSaveSet %ApplyURLParms %Attr
%BindExport %BuildObjectGraph %ClassIsLatestVersion %ClassName
%Close %ConstructClone %CreateApplication %CreatePage
%DetermineCSSLevel %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize
%DrawJSStrings %DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef
%DrawStyleDefinitions %DrawStyleHTML %DrawStyleSVG %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetAllNamespaces
%GetChildIndex %GetClassCRC %GetClassDepth %GetComponent
%GetComponentById %GetComponentByName %GetComponentPropertyById %GetDependentComponents
%GetEventHandlers %GetHomePage %GetHomeParam %GetIncludeFiles
%GetIncludeInfo %GetLinks %GetLocatorInfo %GetLocatorLinks
%GetPageName %GetPaneContents %GetParameter %GetProductName
%GetRootLink %GetSuperClassList %GetValueById %GetValueByName
%GetXMLName %IncrementCount %IsA %IsEmbedded
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%ObjectSynch %OnAddToPage %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnGetPageName
%OnGetProductName %OnGetSmallMenu %OnGetTableLinkMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %ReallyAddChild
%Register %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %XMLGenerate %ZENDeserialize %ZENVersion
BuildMenu CheckAllBlanks CheckContextLinks CheckEnterpriseManager
Condition ConvertParameter CreateResultSet Decrypt
DoLogout DoSearchDelete DoSearchSave DrawBodyInfo
DrawDetailsContent DrawFullContentLinks DrawLocator DrawRibbon
DrawSessionCell DrawTitle Encrypt EncryptBroker
EscapeHTML EscapeURL EvalResult Filter
GetAssistantClass GetCSPURL GetColumnsAndFrom GetContextLinks
GetDocURL GetHomePage GetHyperEventResources GetNewURL
GetQueryHistory GetQuickLinks GetRemoteSearchJob GetSavedSearch
HyperEventBody HyperEventCall HyperEventFrame HyperEventHead
Include InitSearchCriteria InsertHiddenField InsertHiddenFields
InvokeClassMethod InvokeInstanceMethod IsPrivate Link
LoadFilter LoadZenComponent MonitorBackgroundTask OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareCancel QuoteJS ReallyRefreshContents
RegisterRecent RemoveTempData ResetQuery RewriteURL
SaveResendIDs SetSavedSearch SetSearchCriteria ShowError
SignalCancel SimpleKeepAlive StartTimer StopTimer
SubmitFilter Term ThrowError UnescapeHTML
UnescapeURL XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addCriterion
addOR addPopupSuffix adjustExpanderText arrowClick
backgroundTimerHandler cancelPopup cancelSearch changePassword
changeURLNamespace checkEdit checkSearchWarnings childrenMutated
clearBackgroundTask clientKeepAlive clone correctIELayering
createArray createComponent createComponentNS createCondition
deleteComponent deleteSearch disableCommandButton doExport
doResend doSearch dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawDetails drawExtendedCriteria
dropHandler dropStartHandler editCriterion enableCommandButton
endModal executeSearch exposeComponent findElement
fireOnLoadEvent fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getContentAreaHeight getEnclosingDiv getFilter getHidden
getHintElement getLabelElement getNextData getOpener
getPageTitle getProperty getResendURL getResultsTable
getSearchForm getSettings getTargetPage getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton inResizeLoop indicateIfCancelled
initPopupSuffix invokeSuper isOfType launchPopupWindow
layoutTabGroup loadSearch logout makeId
navigate onAfterPageChange onAfterSearch onChangeResultsPage
onCreate onDelete onDisplayHandler onEndModalHandler
onEnsException onPopupAction onRefreshContents onSearchHandler
onSelectItem onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler onTabChange onToggleDetails
onToggleSearch onTraceSVGLoad ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler progressBarHandler refreshContents removeChild
removeCriterion removePopupSuffix render renderContents
renderSVG saveSearch scaleSVGTrace searchBlur
searchBoxHandler searchFocus searchIfValidPageSize searchKeyDown
searchKeyPress selectItem setBackgroundTask setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
shiftTerm showAbout showCommandButton showContact
showDocumentation showFullContent showHelp showQuery
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar submitFilterUpdate switchNamespace testConnectivity
toggleCancelState toggleCriterion toggleDetails toggleSaveAs
toggleSearch toggleSearchState updateControlsInGroup updateFilterFromForm
updateFormFromFilter updateNavigationButtons updatePageData updatePageNumber
updatePageSize updateSearchState

Subclasses
Ens.Enterprise.Portal.EnterpriseSearch Ens.Enterprise.Portal.MsgBankViewer EnsPortal.MessageViewer

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 VirtualKey as %Integer [ InitialExpression = 0 ];
• property assistantClass as %String [ InitialExpression = ..GetAssistantClass(),ReadOnly ];
Name of the Assistant class to use.
• 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 criteriaDialog as %String [ InitialExpression = "EnsPortal.Dialog.SearchCriteria.zen",ReadOnly ];
URL of dialog window to use for editing Search Criteria.
• 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 filterClass as %String [ InitialExpression = "EnsPortal.MsgFilter.Filter",ReadOnly ];
Name of Filter class to use for filtering searches.
• property headerClass as %String [ InitialExpression = "Ens.MessageHeader",ReadOnly ];
Header class to use for queries and display.
• 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 inFirstLoad as %Boolean [ InitialExpression = 1 ];
Flag to indicate whether onLoadHandler has been called yet. This is set to 1 initially, and is set to 0 once onLoadHandler is executed. This is checked before the query is executed to ensure that long running queries are not automatically re-run without user approval.
• property isDefaultFilter as %Boolean [ InitialExpression = 0 ];
Flag to indicate whether the filter values match the defaults. This is set to 0 initially, and calculated in InitSearchCriteria. This determines whether the filter loaded from the session should run automatically, or if we should wait for the user to click 'Search'
• property msgViewTrace as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace") ];
• property msgViewTraceHover as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace including Events and message contents") ];
• property resendPage as %String [ InitialExpression = "EnsPortal.MessageResend.zen" ];
URL of resend page.
• property savedSearchClass as %String [ InitialExpression = "EnsPortal.MsgFilter.SavedSearch",ReadOnly ];
Name of SavedSearch class to use for saving searches.
• property searchWarnings as list of %String;
List of warnings regarding the user's current search criteria.
• property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];
• property tipAddCriterion as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add Criterion") ];
• property tipAddCriterionTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add a new criterion") ];
• property tipAddOR as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add OR") ];
• property tipAddORTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add an OR condition") ];
• property tipDelete as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Delete") ];
• property tipSave as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save") ];
• property tipSaveAs as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Save As") ];

Methods


• method 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
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 [ ZenMethod ]
Server side method to actually delete a named search.
• method DoSearchSave(pSearchName As %String, pIsNew As %Boolean = 0) as %String [ ZenMethod ]
Server side method to actually save a named search.
• method DrawBodyInfo(pHeaderID As %String) as %Status
Write out contents of body details panel. pHeaderID is the message id.
• method DrawDetailsContent(pID As %String) as %Status
Write out contents of details panel. pID is the message id.
• classmethod DrawFullContentLinks(pSeed As %String) as %Status
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
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.
• method Filter() [ Language = javascript ]
Client-side constructor for Filter object.
• classmethod GetAssistantClass() as %String
• classmethod GetQueryHistory(ByRef pParms, Output pMetaData, Output pData) as %Status
• method GetSavedSearch() as %String
Get the current saved search
• private method GetSessionLoc() as %String
• method InitSearchCriteria() as %Status
Initialise the search criteria for the page.
• method LoadFilter(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Load Filter object from the session, or from a saved search if requested.
• classmethod SaveResendIDs(idString As %String) as %String [ ZenMethod ]
Save ID values for Resend.
• method SetSavedSearch(pSearchName As %String = "") as %Status
• method SetSearchCriteria() as %String [ ZenMethod ]
• method SubmitFilter(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, ByRef pObject As %RegisteredObject, Output pResponse As %RegisteredObject) as %Status
Send the Filter to the server.
• method Term(type, sourceClass, conditions) [ Language = javascript ]
Client-side constructor for EnsPortal.MsgFilter.Term object.
• method addCriterion() [ Language = javascript ]
Add a criterion and open the Search Criteria editor for the new object.
• method addOR() [ Language = javascript ]
Add an OR criterion.
• method checkSearchWarnings() [ Language = javascript ]
Check whether any warnings are present after trying to execute a search.
• method clone(object) [ Language = javascript ]
Helper method to allow Search Criteria dialog to create clones of existing Term and Condition objects.
• method 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.
• method 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.
• method deleteSearch(searchName) [ Language = javascript ]
Delete an existing saved search.
• method doExport() [ Language = javascript ]
• method doResend() [ Language = javascript ]
• method drawDetails(messageId) [ Language = javascript ]
Update the details for a selected message.
• method drawExtendedCriteria() [ Language = javascript ]
Client-side method to render the extended criteria expando.
• method editCriterion(index) [ Language = javascript ]
Open the SearchCriteria popup for a criterion.
• method getFilter() [ Language = javascript ]
Client accessor for the Filter current object.
• method 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.
• method 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.
• method loadSearch(searchName, run) [ Language = javascript ]
Load a named search from the server.
• method onAfterSearch() [ Language = javascript ]
Make sure we check for warnings and update the filter from the server after a search is executed.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Subclass need to include the case "switchNamespace" if it is enabling "Switch" next to namespace.
• method onSearchHandler() [ Language = javascript ]
Notify subclass that a search is being executed.
• method 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.
• method onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
• method 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.
• method 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.
• method onloadHandler() [ Language = javascript ]
Ensure that tab behaviour is initialised correctly.
• 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 removeCriterion(index) [ Language = javascript ]
Remove a criterion from the page.
• method saveSearch(searchName, isNew) [ Language = javascript ]
Save the current search criteria to the server.
• method scaleSVGTrace() [ Language = javascript ]
Correctly resize the SVG trace diagram to fit into the current SVG frame size.
• method searchIfValidPageSize(pageSize) [ Language = javascript ]
• method 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'.
• method showFullContent(showRaw) [ Language = javascript ]
• method showQuery() [ Language = javascript ]
Show text of most recent query.
• method submitFilterUpdate() [ Language = javascript ]
Send the current Filter to the server so it can be saved.
• method toggleCriterion(index, enabled) [ Language = javascript ]
• method toggleSaveAs(show) [ Language = javascript ]
Toggle the display of the "Save As" controls and the list controls.
• method updateFilterFromForm(updateSearchCriteria) [ Language = javascript ]
Update the current Filter based on the form's contents. Extended criteria are saved separately.
• method updateFormFromFilter() [ Language = javascript ]
Update the form on the page based on an updated Filter object.
• method 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.