Class 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.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	7	17

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
assistantClass	aux	backgroundTimerInterval	canEdit
canResend	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	criteriaDialog	cssLevel	currSortMode
currStep	currViewMode	currentPage	currentPageStart
currentSearch	detailsHidden	detailsWidth	disabled
dragAndDrop	dragEnabled	dropEnabled	enableAutoRefresh
enclosingClass	enclosingStyle	error	filterClass
groupClass	groupStyle	headerClass	height
hidden	hideDetailsMsg	hideSearchMsg	hint
hintClass	hintStyle	home	homePage
id	ignoreSearchWarnings	index	isFirstPage
isLastPage	keepAliveInterval	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
lblDetails	lblTitle	limitPopups	msgCloseDetail
msgNotPermitted	msgViewTrace	msgViewTraceHover	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageId	pageModified	pageNumberId
pageSizeId	parent	queryAtEnd	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
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%AddImportedComponents	%AddLocatorLinks
%AddToSaveSet	%ApplyURLParms	%Attr	%BindExport
%ClassIsLatestVersion	%ClassName	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions
%DrawComponentHTML	%DrawHTML	%DrawHTMLPage	%DrawJSStrings
%DrawObjectDefinitions	%EnclosingDivId	%EndBackgroundMethod	%EndScript
%Eval	%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetComponent	%GetComponentById	%GetComponentByName
%GetEventHandlers	%GetHomePage	%GetHomeParam	%GetLinks
%GetLocatorLinks	%GetPageName	%GetParameter	%GetProductName
%GetRootLink	%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	%OnGetPageName	%OnGetProductName
%OnGetSmallMenu	%OnGetTableLinkMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	CheckAllBlanks	CheckContextLinks	CheckEnterpriseManager
Condition	ConvertParameter	CreateResultSet	Decrypt
DoLogout	DoPurge	DoSearchDelete	DoSearchSave
DrawBodyInfo	DrawDetailsContent	DrawFullContentLinks	DrawLocator
DrawRibbon	DrawSessionCell	DrawTimeCreated	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
Filter	GetAssistantClass	GetCSPURL	GetColumnsAndFrom
GetContextLinks	GetCount	GetDocURL	GetHomePage
GetHyperEventResources	GetNewURL	GetQueryHistory	GetQuickLinks
GetRemoteSearchJob	GetSavedSearch	HyperEventCall	HyperEventHead
Include	InitSearchCriteria	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	LoadFilter
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	PrepareCancel	QuoteJS
RegisterRecent	RemoveTempData	ResetQuery	RewriteURL
SaveResendIDs	SetSavedSearch	SetSearchCriteria	ShowError
SignalCancel	SimpleKeepAlive	StartTimer	StopTimer
SubmitFilter	Term	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
addCriterion	addOR	addPopupSuffix	adjustExpanderText
arrowClick	cancelPopup	cancelSearch	changePassword
changeURLNamespace	checkEdit	checkSearchWarnings	childrenMutated
clientKeepAlive	clone	correctIELayering	countReset
createArray	createComponent	createComponentNS	createCondition
createTimeWarning	deleteComponent	deleteSearch	disableCommandButton
displayCountDown	doExport	doResend	doSearch
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
drawDetails	drawExtendedCriteria	dropHandler	dropStartHandler
editCriterion	enableCommandButton	endModal	enterKey
executeSearch	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getContentAreaHeight	getEnclosingDiv
getFilter	getHidden	getHintElement	getLabelElement
getNextData	getOpener	getPageTitle	getProperty
getResendURL	getResultsTable	getSearchForm	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	hideTimeoutWarning
hideWarnContinue	inResizeLoop	indicateIfCancelled	initPopupSuffix
invokeSuper	isOfType	launchPopupWindow	layoutTabGroup
loadSearch	logout	makeId	manualKeepAlive
navigate	onAfterPageChange	onAfterSearch	onChangeResultsPage
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onEnsException	onPopupAction	onRefreshContents	onSearchHandler
onSelectItem	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	onTabChange	onToggleDetails
onToggleSearch	onTraceSVGLoad	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents	removeChild
removeCriterion	removePopupSuffix	render	renderContents
renderSVG	saveSearch	scaleSVGTrace	searchBlur
searchBoxHandler	searchFocus	searchIfValidPageSize	searchKeyDown
searchKeyPress	selectItem	setComponentId	setConnectivityStatusMsg
setHidden	setModified	setOverlayMode	setPageTitle
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	setWarnInnerHTML
shiftTerm	showAbout	showCommandButton	showContact
showDocumentation	showFullContent	showHelp	showQuery
showTimeoutWarning	showTrace	startKeepAlive	startModal
startProgressBar	startPurge	stopKeepAlive	stopProgressBar
submitFilterUpdate	switchNamespace	toggleCancelState	toggleCriterion
toggleDetails	toggleSaveAs	toggleSearch	toggleSearchState
updateFilterFromForm	updateFormFromFilter	updateNavigationButtons	updatePageData
updatePageNumber	updatePageSize	updateSearchState	warnclickListener

Parameters

• 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.

• parameter SETUPTEMPPORTALNODE = 1;

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

• property assistantClass as %String [ InitialExpression = ..GetAssistantClass(),ReadOnly ];

Name of the Assistant class to use.

• property canResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageResend","USE") ];

Flag to indicate whether a user may resend messages.

• property criteriaDialog as %String [ InitialExpression = "Ens.Enterprise.Portal.SearchCriteria.zen",ReadOnly ];

URL of dialog window to use for editing Search Criteria.

• property filterClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.Filter",ReadOnly ];

Name of Filter class to use for filtering searches.

• property headerClass as %String [ InitialExpression = "Ens.Enterprise.MsgBank.MessageHeader",ReadOnly ];

Header class to use for queries and display.

• property resendPage as %String [ InitialExpression = "Ens.Enterprise.Portal.MessageResend.zen" ];

URL of resend page.

• property savedSearchClass as %String [ InitialExpression = "Ens.Enterprise.Portal.MsgFilter.SavedSearch",ReadOnly ];

Name of SavedSearch class to use for saving searches.

Methods

• method %OnAfterCreatePage() as %Status

Fill search criteria defaults

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• classmethod DoPurge(keep As %Integer) as %String [ 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

• classmethod GetAssistantClass() as %String

• classmethod GetCount() as %Integer [ 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

Get information to display in the ribbon bar.

• method countReset() [ Language = javascript ]

Reset the current count of Message Bank entries

• method 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

• method onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]

Callback to set up the resultset/query for paging

• method onlayoutHandler(load) [ Language = javascript ]

Ensure we don't call onlayoutHandler() reentrantly under older versions of IE8

• method 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.

• method startPurge() [ Language = javascript ]

User clicked the Purge button

• 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 updatePageData() [ Language = javascript ]

Helper method to record the first and last ID values for the current page.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search