Class EnsPortal.Dialog.ExportMessages

class EnsPortal.Dialog.ExportMessages extends EnsPortal.Dialog.standardDialog

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	9	19

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BackgroundWFRole	FirstFailed	InvalidParam
IsEMSReadOnly	ValidationErrorMsg	align	aux
backgroundTimerInterval	canEdit	cellAlign	cellSize
cellStyle	cellVAlign	children	cleanedUp
closeOnEnter	closeOnEsc	composite	containerStyle
cssLevel	dialogTitle	disabled	disabledStyle
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	groupClass	groupStyle
hasButtons	height	hidden	hideApplyButton
hideCancelButton	hideOKButton	hint	hintClass
hintStyle	id	index	keepAliveInterval
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	msgNotOK	msgNotPermitted
msgQuantity	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
permittedForBackground	queuedSessionId	savedSearch	searchClass
showLabel	slice	studioMode	tempKey
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter
%AddChildBefore	%AddComponent	%AddEnsExceptionHandler
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings
%DrawObjectDefinitions	%DrawTitle	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval
%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetComponent	%GetComponentById
%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%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
%OnGetSubtitle	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP
%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueL10N	%RemoveChild	%RemoveChildren
%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified
%SetValueById	%SetValueByName	%SetValuesByName
%StartScript	%ValidateObject	%ZENVersion
CheckFileStatus	CleanupExportIDs	CleanupTemporaryServerFile
ConvertParameter	CreateTempFile	Decrypt
DoSearchDelete	DownloadStream	DrawInfo
Encrypt	EscapeHTML	EscapeURL
EvalResult	GetHyperEventResources	HyperEventCall
HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page
QueueSearchForExport	QuoteJS	RewriteURL
ShowError	SimpleKeepAlive	StartTimer
StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore
addPopupSuffix	adjustSize	btnApply
btnOK	cancelPopup	checkEdit
childrenMutated	clientKeepAlive	correctIELayering
createComponent	createComponentNS	ctrlKeyDown
deleteComponent	dialogApply	dialogCancel
dialogFinish	dialogTitleGet	disableButtons
doDownload	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getDialogValue
getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty
getSettings	getType	gotoPage
inResizeLoop	initPopupSuffix	invokeSuper
isOfType	launchPopupWindow	makeId
onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondialogCancel
ondialogFinish	ondialogStart	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents
removeChild	removePopupSuffix	render
renderContents	renderSVG	resetMsg
setComponentId	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption
showMsg	startKeepAlive	startModal
startProgressBar	stopKeepAlive	stopProgressBar
tempServerDirectory	tempServerFilename	userPermittedForBackgroundRequest
validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter BACKGROUNDPROCESSOR = "EnsLib.Background.Process.ExportMessageSearch";

This is the BP(L) that will process the background request

• parameter DOMAIN = "Ensemble";

Localization domain

• parameter PRIVATE = 1;

Controls the access to the page, it can be set to one of the following:

PRIVATE=0 - Page can be linked to/bookmarked

PRIVATE=1 - Can only be referenced from another CSP page

The user needs initially to enter the site through a PUBLIC page.

• parameter RESOURCE = "%Ens_MessageExport:USE";

Users must have USE permissions on the %Ens_MessageExport resource to use this page.

• parameter XDEVBUFFERSIZEMAX = 128;

• parameter XDEVBUFFERSIZEMIN = 4;

Properties

• property BackgroundWFRole [ InitialExpression = "%ProductionMessageExport" ];

This is the Workflow Role that will process the background request

• property cleanedUp as %ZEN.Datatype.string;

• property msgNotOK as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Not permitted. Please see the reason above.") ];

• property msgQuantity as %ZEN.Datatype.integer(ZENURL="QUANTITY");

• property permittedForBackground as %ZEN.Datatype.boolean;

• property queuedSessionId as %ZEN.Datatype.string;

• property savedSearch as %ZEN.Datatype.string(ZENURL="SAVEDSEARCH");

• property searchClass as %String [ InitialExpression = "EnsPortal.MsgFilter.SavedSearch",ReadOnly ];

• property tempKey as %ZEN.Datatype.string(ZENURL="KEY");

This starts off being the id in IRIS.Temp.ResendIDs but is then updated to be the id in SessionEvents to ensure it can be cleaned up when user logs out.

Methods

• method %OnAfterCreatePage() as %Status

Avoid writing out the session cookie if we are in a Studio session.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

• method CheckFileStatus(pDocName, pKey) [ ZenMethod ]

• classmethod CleanupExportIDs(pKey As %String) as %String [ ZenMethod ]

Cleanup temp of saved ids.

• classmethod CleanupTemporaryServerFile(pDocName As %String, pKey As %String) as %Integer [ ZenMethod ]

Cleanup temporary server side file

• classmethod CreateTempFile(pDocName, pKey, pCharSet, pMsgSep, pRS, pUsername=$username) as %String [ ZenMethod ]

This method is also called from background business process as well as SMP. throws error if error status encountered

• method DoSearchDelete() as %Status [ ZenMethod ]

Server side method to delete the temporary search

• classmethod DownloadStream(pDocName As %String, pCharSet As %String, pKey As %String) [ ZenMethod ]

• method DrawInfo(pSeed As %String) as %Status

Draw contents of description box.

• method QueueSearchForExport() as %Status [ ZenMethod ]

• method doDownload() [ Language = javascript ]

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method ondialogCancel() [ Language = javascript ]

This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.

• method ondialogFinish(action) as %Boolean [ Language = javascript ]

This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.

• classmethod tempServerDirectory() as %String

• classmethod tempServerFilename(pDocName, pKey, pUsername=$username) as %String

• method userPermittedForBackgroundRequest(Output pReason) as %Boolean

Class Reference IRIS for UNIX 2024.1.2
Documentation Search