Class %CSP.UI.Portal.SQL.ExportStatement

class %CSP.UI.Portal.SQL.ExportStatement extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Export SQL Statement dialog for Management Portal SQL.

Please do not modify any part of this dialog without COMPLETELY testing all cases!!!
This dialog is used by SQL for exporting single SQL statement or all statements per namespace.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6	4	19

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	EXPORTALL	FILETYPE	FirstFailed
HASH	InvalidParam	IsEMSReadOnly	NAMESPACE
ValidationErrorMsg	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	cssLevel
dialogTitle	disabled	disabledStyle	dragAndDrop
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
helpId	hidden	hideApplyButton	hideCancelButton
hint	hintClass	hintStyle	id
index	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	parent	showLabel	slice
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%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	ConvertParameter	Decrypt
DownloadStream	DrawPageTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	FileExists	GetTempFileName
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsEnabled	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	SaveLastFile
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	browseSelect	btnApply
btnOK	canFinish	canGoBack	canGoNext
cancelPopup	childrenMutated	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doDownload	doExport	doLocationChange	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
formValidationHandler	getChildIndex	getComponent	getComponentById
getDialogValue	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getType	gotoPage	hasMultiplePages	invokeSuper
isOfType	launchPopupWindow	makeId	nextPage
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondialogCancel
ondialogFinish	ondialogStart	ondisabledHandler	onfinishHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onstartHandler	onunloadHandler	onupdateHandler	popupActionHandler
previousPage	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	setComponentId
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	showDocumentation	showHelp	showMsg
startModal	startProgressBar	stopProgressBar	updateState
validateFile	validateRequired

Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";

Class name of application this page belongs to.

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter AUTONS = 1;

If $NAMESPACE is set, auto switch namespace

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.SQL.ExportStatement.zen";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter PAGENAME = "ExportSQLStatement";

Displayed name of this page.

• parameter RESOURCE = "%Development:USE";

This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

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

1 = Export All; 0 = Export individual statement where HASH should be defined.

• property FILETYPE as %ZEN.Datatype.string [ InitialExpression = "SQLSTATEMENT" ];

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

If export individual statement, HASH is not null

• property NAMESPACE as %ZEN.Datatype.string(ZENURL="$NAMESPACE");

Methods

• method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.

• 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(pFilename) [ ZenMethod ]

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

• classmethod DrawPageTitle(pSeed As %String) as %Status

• classmethod FileExists(filename) as %Integer [ ZenMethod ]

Check to see if file exists

• method GetTempFileName(pDocName) as %String [ ZenMethod ]

• classmethod SaveLastFile(pFileName, pFileType) [ ZenMethod ]

• method browseSelect(name, wildcard) [ Language = javascript ]

User clicked the Browse button.

• method doDownload(filename) [ Language = javascript ]

• method doExport() [ Language = javascript ]

User clicked the Export or Export in Background button.

• method doLocationChange(flag) [ Language = javascript ]

User changed to export file between Server or Browser

• method getDialogValue() [ Language = javascript ]

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

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method onresizeHandler() [ Language = javascript ]

This client event, if present, is fired when the page is resized.

• method onstartHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method validateFile(fileName) [ Language = javascript ]

Check if file is empty.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search