Class %CSP.UI.Portal.Background.Dialog.DatabaseDefragment

class %CSP.UI.Portal.Background.Dialog.DatabaseDefragment extends %CSP.Portal.standardDialog, %CSP.UI.Portal.Background.Utils

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	5	8

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	DBName	Directory	FirstFailed
InvalidParam	IsEMSReadOnly	OpenDetailsPage	OutputPage
SysBGTaskId	ValidationErrorMsg	WarningMessage	align
aux	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	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	DrawAbortError
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetTaskInfo	GetTaskList	HasEnded	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link	LogMsg
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RewriteURL	ShowError	StartDefrag
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
adjustSize	btnApply	btnOK	cancelPopup
childrenMutated	correctIELayering	createComponent	createComponentNS
ctrlKeyDown	deleteComponent	dialogApply	dialogCancel
dialogFinish	dialogTitleGet	disableButtons	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	drawData
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getDialogValue	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getType	gotoPage	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	openDetails
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	setComponentId
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	showMsg	startModal	startProgressBar
stopProgressBar	timeout	updateButtons	validateRequired

Parameters

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

This is the class name of this application this page belongs to. If not defined, this page does not belong to an application.

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter CSPURL = "/csp/sys/op/%CSP.UI.Portal.Background.Dialog.DatabaseDefragment.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 = "Defragment";

Displayed name of this page.

• parameter RESOURCE = "%Admin_Operate: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 DBName as %String(ZENURL="DBName");

ID for edit. DBName for this page.

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

DBDirectory passed in.

• property SysBGTaskId as %String;

• property WarningMessage as %String;

• property disabledStyle as %ZEN.Datatype.style [ InitialExpression = "background-image:none;background:#D0D0D0;cursor: not-allowed;" ];

Style applied to buttons when automatically disabled.

Methods

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• 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 DrawAbortError(seed As %String) as %Status

• classmethod StartDefrag(pDBName, pDirectory) as %ZEN.proxyObject [ ZenMethod ]

Start background job to defragment a selected directory

• method getDialogValue() [ Language = javascript ]

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

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


[USER] > [%CSP] > [UI] > [Portal] > [Background] > [Dialog] > [DatabaseDefragment]		Private Storage