Class %CSP.UI.Portal.Dialog.ColumnPriv

class %CSP.UI.Portal.Dialog.ColumnPriv extends %CSP.Portal.standardDialog, %CSP.UI.Component.SelectBoxUtils

Page to define SQL Table/View column privileges.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	9	27

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Column	FirstFailed	IncludeSystem
InvalidParam	IsEMSReadOnly	Namespace	ObjName
ObjectType	PID	Schema	Table
TotalColumns	ValidationErrorMsg	align	aux
avaList	backgroundTimerInterval	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
containerStyle	cssLevel	dialogTitle	disabled
disabledStyle	dragAndDrop	dragEnabled	dropEnabled
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	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	selList
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	ColumnEdit	ConvertParameter	Decrypt
DrawArrows	DrawArrowsOld	DrawAvailableList	DrawSelectBoxes
DrawSelectList	DrawTable	DrawUpArrowsOld	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetColumns
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PopulateSchemas	QuoteJS	RewriteURL	SaveData
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	UpdateDetails	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	adjustSize	btnApply
btnOK	cancelPopup	changeSchema	changeTable
checkAll	checkboxModified	childrenMutated	clearList
correctIELayering	createComponent	createComponentNS	ctrlKeyDown
deleteComponent	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	doAddColumn	doEditColumn
doModified	doRevokeColumn	doSelectBoxMove	doSelectBoxMoveAll
doSelectBoxMoveItem	doSelectBoxMoveList	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getDialogValue	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getProperty	getSelList	getSettings	getType
gotoPage	invokeSuper	isOfType	isSomethingChecked
launchPopupWindow	makeId	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSelectBoxMove	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondialogCancel	ondialogFinish
ondialogStart	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	setComponentId
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	showMsg	startModal	startProgressBar
stopProgressBar	toggleChecks	toggleSave	uncheckAllBoxes
validateRequired

Parameters

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

Class name of application this page belongs to.

• parameter APPLYBUTTON = 1;

If true, then this dialog displays an Apply button.

• parameter AUTONS = 1;

If true, auto-switch namespace to whatever $NAMESPACE is passed in.

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.Dialog.ColumnPriv.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 DOMAIN = "%Utility";

Domain used for localization.

• parameter PAGENAME = "Column Privileges";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Secure: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 Column as %String;

Table column name if user is editing or revoking

• property IncludeSystem as %Integer(ZENURL="IncludeSystem") [ InitialExpression = 0 ];

Flag indicating whether user checked the "Include System Items" checkbox.

• property Namespace as %String(ZENURL="$NAMESPACE");

Namespace indicating where the schemas/tables/views are coming from.

• property ObjName as %String(ZENURL="ObjName");

ObjName = null for Add, or Table name or View name for Edit

• property ObjectType as %String(ZENURL="Type");

"TABLE" or "VIEW".

• property PID as %String(ZENURL="PID");

User or Role whose privileges are being granted

• property Schema as %String;

User selected schema name

• property Table as %String;

User selected table name

• property TotalColumns as %Integer [ InitialExpression = 0 ];

Total number of existing columns for edit

Methods

• method %OnAfterCreatePage() as %Status

Set Locator bar and determine whether to show change password option.

• 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 ColumnEdit(pSchema, pTable, pColumn) as %ZEN.proxyObject [ ZenMethod ]

When editing existing column priv, this method loads existing column priv into check boxes

• method DrawSelectBoxes(seed As %String) as %Status

• method DrawTable(seed As %String) as %Status

Draws table for existing table column priv allowing user to edit or revoke.

• classmethod GetColumns(PID As %String, Schema As %String, Table As %String, IncludeSystem As %Integer, Output Columns As %String) as %Status

Return existing columns

• method PopulateSchemas() as %Status

• classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]

Save column priv data to server If this is to revoke column priv, then pRevoke = 1, pPrivs and pGrant will be null.

• classmethod UpdateDetails(Schema As %String, Table As %String, PID As %String, IncludeSystem As %Integer) as %ZEN.proxyObject [ ZenMethod ]

Load fields into Available/Selected list boxes.

• method changeSchema(newVal) [ Language = javascript ]

User changed or selected a schema. Load Table list based on the schema selected.

• method changeTable(newVal) [ Language = javascript ]

User selected a table. Load Available/Selected list boxes.

• method checkAll(ID) [ Language = javascript ]

Check if Priv or Grant are all checked. check chkPriv/chkGrant if all its checkboxes are checked; uncheck if at least one is unchecked.

• method checkboxModified(id, g) [ Language = javascript ]

User changed a checkbox.

• method disableButtons(flag) [ Language = javascript ]

Disable or enable the apply,cancel, and ok buttons for this dialog. Overriding %ZEN.Dialog.standardDialog (called by dialogFinish() and dialogCancel())

• method doAddColumn(newVal) [ Language = javascript ]

User clicked "Add Columns" to add more columns to existing schema.table

• method doEditColumn(column) [ Language = javascript ]

User clicked "Edit" to edit existing column priv

• method doModified() [ Language = javascript ]

• method doRevokeColumn(column) [ Language = javascript ]

User clicked "Revoke" to revoke existing column priv

• method getDialogValue() [ Language = javascript ]

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

• method isSomethingChecked() [ Language = javascript ]

• method onSelectBoxMove(flag, isPage) [ Language = javascript ]

• 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 toggleChecks(g, newVal) [ Language = javascript ]

User clicked the Privilege/Grant Admin checkbox.

• method toggleSave(enable) [ Language = javascript ]

• method uncheckAllBoxes() [ Language = javascript ]


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