Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.MessageResendEdit
Private  Storage   

EnsPortal.MessageResendEdit


class EnsPortal.MessageResendEdit extends
EnsPortal.Template.standardPage

This is the Message Resend page of the ZEN application. We always do a "resend" from the message viewer page but a "resubmit" from the suspended messages page.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 13 12


Summary


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

Properties
%condition %import %includeFiles %page
%resource HeadOfQueue Header HelpAddress
ISREADONLY Key LocatorHeader NewTarget
ParentURL Send StdTitle Suspended
aboutPage align aux backgroundTimerInterval
canEdit canViewContents canViewHeaders canViewTrace
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
messageDisplayPage messageTracePage msgNotPermitted name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent resendResultPage
searchKey showLabel slice title
tuple useSVG useSoftModals valign
viewerPage 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 %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 CleanUpIDs
ConvertParameter Decrypt DoLogout DrawHTMLFields
DrawLocator DrawRibbon DrawTitle Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetContextLinks GetDocURL GetHomePage GetHyperEventResources
GetNewURL GetQuickLinks GetSubmitURL HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PerformResend QuoteJS RegisterRecent RewriteURL
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addPopupSuffix arrowClick
cancelPopup changePassword changeURLNamespace checkEdit
childrenMutated clientKeepAlive correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton inResizeLoop
initPopupSuffix invokeSuper isOfType launchPopupWindow
logout makeId navigate onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild removePopupSuffix
render renderContents renderSVG saveEdit
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showBody
showCommandButton showContact showDocumentation showHeader
showHelp showTrace startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace

Subclasses
Ens.Enterprise.Portal.MessageResendEdit

Parameters


• parameter HEADERCLASS = "Ens.MessageHeader";
• parameter PAGENAME = "Message Edit and Resend";
Displayed name of this page.
• parameter RESOURCE = "%Ens_MessageEditResend:USE";
User needs USE permissions on the %Ens_MessageEditResend resource to view this page.

Properties


• property HeadOfQueue as %ZEN.Datatype.boolean(ZENURL="HEAD") [ InitialExpression = 0 ];
If supplied and true, this means to put this message at the head of its queue
• property Header as %ZEN.Datatype.string(ZENURL="HDR");
The actual message header identifier
• property Key as %ZEN.Datatype.string(ZENURL="KEY");
Identifies in which global to find the message header identifier
• property NewTarget as %ZEN.Datatype.string(ZENURL="TARGET");
If supplied, this is the new target to which to send the message
• property Send as %ZEN.Datatype.boolean(ZENURL="SEND") [ InitialExpression = 0 ];
If true, this is the second time through this page and we are definitely resending the message. Otherwise it is the first time through.
• property Suspended as %ZEN.Datatype.boolean(ZENURL="SUSP") [ InitialExpression = 0 ];
If supplied and true, this tells us that the parent page is the suspended messages page rather than the message viewer page. We always do a "resend" from the message viewer page but a "resubmit" from the suspended messages page. Resend - clone a new header for the message and send with the new header. Resubmit - do not clone a new header for the message, instead resubmit using the old header.
• property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageContent","USE") ];
• property canViewHeaders as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageHeader","USE") ];
• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
• property messageDisplayPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.Dialog.MessageBodyDisplay.zen" ];
Page to use for displaying message content.
• property messageTracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];
Page for displaying the visual trace.
• property resendResultPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageResendAfter.zen" ];
Page to use for displaying the results of the resend.
• property viewerPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageViewer.zen" ];
Page for displaying messages.

Methods


• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• method CleanUpIDs() as %String [ ZenMethod ]
Get rid of the global that has been storing the information about our chosen messages. This happens only if we are truly done with this page.
• method DrawHTMLFields(tSessionId As %String) as %Status
Provide HTML for editing the selected message. Most code extracted from old CSP page.
• method GetSubmitURL() as %String
• 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 PerformResend(pHeader As Ens.MessageHeaderBase, pNewBody As %RegisteredObject, Output pNewHeaderId As %String, Output pText) as %Status
• 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 saveEdit() [ Language = javascript ]
Modified from the earlier CSP version of this page, which was IE-specific. This method is invoked when the user clicks OK on the automatically generated HTML form from DrawHTMLFields(). It references fields on the form and submits the form. Then it displays the URL provided when the form was created in DrawHTMLFields().
• method showBody(messageId) [ Language = javascript ]
Update the details for a selected message.
• method showHeader(messageId) [ Language = javascript ]
Update the details for a selected message.
• method showTrace(session) [ 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 display.