Home > Class Reference > ENSLIB namespace > Ens.Enterprise.Portal.MsgBankViewer


class Ens.Enterprise.Portal.MsgBankViewer extends EnsPortal.Template.filteredViewer, Ens.Enterprise.Portal.base

This is the Message Bank Viewer page of the ZEN application.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
parameter PAGENAME = Message Bank Viewer;
Displayed name of this page.
parameter RESOURCE = %Ens_MsgBank_MessageHeader:USE;
User needs USE permissions on the %Ens_MsgBank_MessageHeader resource to view this page.
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.
parameter SessionSubscripts = MsgBank,SavedSearch;
Comma separated list of subscripts to use in the %session object for saved searches.

Properties (Including Private)

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 = $system.Security.Check("%Ens_MsgBank_MessageResend","USE") ];
Flag to indicate whether a user may resend messages.
Property methods: canResendDisplayToLogical(), canResendGet(), canResendIsValid(), canResendLogicalToDisplay(), canResendLogicalToOdbc(), canResendLogicalToXSD(), canResendNormalize(), canResendSet(), canResendXSDToLogical()
property criteriaDialog as %String [ InitialExpression = "Ens.Enterprise.Portal.SearchCriteria.zen" , ReadOnly ];
URL of dialog window to use for editing Search Criteria.
Property methods: criteriaDialogDisplayToLogical(), criteriaDialogGet(), criteriaDialogIsValid(), criteriaDialogLogicalToDisplay(), criteriaDialogLogicalToOdbc(), criteriaDialogNormalize()
property filterClass as %String [ InitialExpression = "Ens.Enterprise.Portal.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.Enterprise.MsgBank.MessageHeader" , ReadOnly ];
Header class to use for queries and display.
Property methods: headerClassDisplayToLogical(), headerClassGet(), headerClassIsValid(), headerClassLogicalToDisplay(), headerClassLogicalToOdbc(), headerClassNormalize()
property resendPage as %String [ InitialExpression = "Ens.Enterprise.Portal.MessageResend.zen" ];
URL of resend page.
Property methods: resendPageDisplayToLogical(), resendPageGet(), resendPageIsValid(), resendPageLogicalToDisplay(), resendPageLogicalToOdbc(), resendPageNormalize(), resendPageSet()
property savedSearchClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.SavedSearch" , ReadOnly ];
Name of SavedSearch class to use for saving searches.
Property methods: savedSearchClassDisplayToLogical(), savedSearchClassGet(), savedSearchClassIsValid(), savedSearchClassLogicalToDisplay(), savedSearchClassLogicalToOdbc(), savedSearchClassNormalize()

Methods (Including Private)

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Fill search criteria defaults
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
classmethod DoPurge(keep As %Integer) as %String [ Language = objectscript, ZenMethod ]
Perform the purge operation and if there is an error, return the message to JavaScript by prepending the message with a '-'. If no error then return the zero or positive number of entries deleted, as a string.
method DrawTimeCreated(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
classmethod GetAssistantClass() as %String [ Language = objectscript ]
classmethod GetCount() as %Integer [ Language = objectscript, ZenMethod ]
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status [ Language = objectscript ]
Get information to display in the ribbon bar.
clientmethod countReset() [ Language = javascript ]
Reset the current count of Message Bank entries
clientmethod enterKey() [ Language = javascript ]
Use with certain fields so user can hit Enter to indicate that an entry in the field is done and ready to use
clientmethod onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging
clientmethod onlayoutHandler(load) [ Language = javascript ]
Ensure we don't call onlayoutHandler() reentrantly under older versions of IE8
clientmethod showTrace(session, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the Message Bank Viewer.
clientmethod startPurge() [ Language = javascript ]
User clicked the Purge button
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 updatePageData() [ Language = javascript ]
Helper method to record the first and last ID values for the current page.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)