Class %CSP.UI.Portal.Dialog.SQLView

class %CSP.UI.Portal.Dialog.SQLView 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.

Edit SQL View for Management Portal

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	5	14

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BuilderPage	FirstFailed	InvalidParam
IsEMSReadOnly	NAMESPACE	SCHEMA	VIEWNAME
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	isNew	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	ConvertParameter	Decrypt	DrawPageTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsEnabled	IsPrivate	JavaInstalled
Link	ListSchemas	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RewriteURL
SaveData	ShowError	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	adjustSize	btnApply
btnOK	canFinish	canGoBack	canGoNext
cancelPopup	childrenMutated	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doQueryBuilder	doSave	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	showNewSchema
startModal	startProgressBar	stopProgressBar	updateState
validate	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 CSPURL = "/csp/sys/exp/%CSP.UI.Portal.Dialog.SQLView.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 = "SQLViewEdit";

Displayed name of this page.

• parameter RESOURCE = "%Development";

Security requirement

Properties

• property BuilderPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.SQL.QueryBuilderWindow.cls",,1) ];

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

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

Schema name, may or may not be available.

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

When editing, this is passed in.

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

Indicate whether this is to create or edit view.

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.

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

• method ListSchemas(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean

Method for executing the schemas query.

• classmethod SaveData(isNew, Schema, ViewName, ViewText, CheckOption, GrantPublic) as %String [ ZenMethod ]

VIEWNAME, Schema, ViewName, ViewText, CheckOption, ReadOnly

• method doQueryBuilder() [ Language = javascript ]

• method doSave() [ 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 onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.

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

• method onloadHandler() [ Language = javascript ]

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

• method showNewSchema() [ Language = javascript ]

• method validate() [ Language = javascript ]

If creating a new view, make sure that the view name is not empty.


[USER] > [%CSP] > [UI] > [Portal] > [Dialog] > [SQLView]		Private Storage