Class %CSP.UI.Portal.SQL.ExecuteQuery

class %CSP.UI.Portal.SQL.ExecuteQuery extends %CSP.UI.Portal.Template

System Management Portal - SQL Execute Query

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	5	28

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	BuilderPage	Dialect	HelpAddress
ISREADONLY	LocatorHeader	MaxRows	ParentURL
RuntimeMode	StdTitle	TotalTabs	aboutPage
align	aux	backgroundTimerInterval	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	cssLevel	currSortMode
currStep	currViewMode	disabled	dragAndDrop
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	parent	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%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
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetPageName
%GetParameter	%GetProductName	%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	ConvertParameter	Decrypt
DoLogout	DrawError	DrawHTML	DrawLocator
DrawMessages	DrawOutputColumns	DrawResult	DrawResultSet
DrawRibbon	DrawShowPlan	DrawSimpleResult	DrawTabBox
DrawTabs	DrawTitle	Encrypt	EscapeHTML
EscapeURL	ExecuteQuery	GetCSPURL	GetContextLinks
GetDocPage	GetHomePage	GetNewURL	GetQuickLinks
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PrepareAction
QuoteJS	RegisterRecent	RewriteURL	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	ZStripW	addChild	addChildAfter
addChildBefore	cancelPopup	changePassword	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
doExecute	doHistory	doQueryBuilder	doShowPlan
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	historyChanged	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	render	renderContents	renderSVG
resetMsg	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	setComponentId	setHidden
setModified	setOverlayMode	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showDocumentation	showHelp
showMsg	startModal	startProgressBar	stopProgressBar
switchNamespace	tabChanged	updateParameters	validateText

Parameters

• parameter AUTONS = 1;

Switch namespace $NAMESPACE is present

• parameter CSPURL = "%CSP.UI.Portal.SQL.ExecuteQuery.cls";

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 = "SQL.ExecuteQuery";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/%CSP.Portal.Home.cls";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RESOURCE = "%Admin_Developer";

Security requirement

Properties

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

• property Dialect as %ZEN.Datatype.string [ InitialExpression = "Nothing" ];

• property MaxRows as %ZEN.Datatype.string [ InitialExpression = "1000" ];

• property RuntimeMode as %ZEN.Datatype.string [ InitialExpression = "2" ];

Default is Display Mode

• property TotalTabs as %ZEN.Datatype.integer [ InitialExpression = "1" ];

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• classmethod DrawError(pResult As %SQL.StatementResult, ByRef pMessages As %String(MAXLEN=""))

DrawError will draw the HTML for an invalid SQLCODE.

• classmethod DrawHTML(pText As %String(MAXLEN="")) as %Status

• classmethod DrawMessages(pPtr As %Integer = 1, ByRef pMessages As %String(MAXLEN=""))

• classmethod DrawOutputColumns(pPtr As %Integer = 0, pResult As %SQL.StatementResult, ByRef pMessages As %String(MAXLEN=""))

• classmethod DrawResult(pResult As %SQL.StatementResult)

DrawResult will draw all of the result information returned in the statement result object.

• classmethod DrawResultSet(pPtr As %Integer, pResult As %SQL.StatementResult, ByRef pMessages As %String(MAXLEN=""))

DrawResult

• classmethod DrawShowPlan(pText As %String(MAXLEN="")) as %Status

• classmethod DrawSimpleResult(pResult As %SQL.StatementResult, ByRef pMessages As %String(MAXLEN=""))

DrawSimpleResult will draw the HTML for a successful execution of a simple non-resultset returning statement.

• classmethod DrawTabBox(menuHd As %String, tabCaption As %String, t As %Integer, totalTabs As %Integer)

Draws unselected tab

• classmethod DrawTabs(totalResultsets, pOutputValues As %Integer = 0)

• classmethod ExecuteQuery(pText As %String(MAXLEN="")) as %String [ 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.

• classmethod PrepareAction(pText) as %String [ ZenMethod ]

Save user's latest query text into global for later execution

• method doExecute() [ Language = javascript ]

• method doHistory() [ Language = javascript ]

• method doQueryBuilder() [ Language = javascript ]

• method doShowPlan() [ Language = javascript ]

• method historyChanged(hist) [ Language = javascript ]

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

This client event is fired when the a popup page launched from this page fires an action.

• method onlayoutHandler() [ Language = javascript ]

This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.

• 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 tabChanged(tab, totalTabs) [ Language = javascript ]

user clicked a tab. hide/show result tables, and alter tab's background color.

• method updateParameters() [ Language = javascript ]

• method validateText() [ Language = javascript ]


[BASEXML] > [%CSP] > [UI] > [Portal] > [SQL] > [ExecuteQuery]		Private Storage