Home > Class Reference > %SYS namespace > %CSP.UI.Portal.Background.Dialog.DatabaseCompact


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

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLICATION = %CSP.UI.Portal.Application;
Inherited description: 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.DatabaseCompact.zen;
Inherited description: 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 = Compact;
Displayed name of this page.
parameter RESOURCE = %Admin_Operate:USE;
Inherited description: 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:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties (Including Private)

property DBName as %String (ZENURL = "DBName");
ID for edit. DBName for this page.
Property methods: DBNameDisplayToLogical(), DBNameGet(), DBNameIsValid(), DBNameLogicalToDisplay(), DBNameLogicalToOdbc(), DBNameNormalize(), DBNameSet()
property Directory as %String (ZENURL = "Directory");
DBDirectory passed in.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property EndFree as %Integer;
Amount free at end
Property methods: EndFreeDisplayToLogical(), EndFreeGet(), EndFreeIsValid(), EndFreeLogicalToDisplay(), EndFreeNormalize(), EndFreeSet(), EndFreeXSDToLogical()
property FreeSpace as %String;
Total available freespace.
Property methods: FreeSpaceDisplayToLogical(), FreeSpaceGet(), FreeSpaceIsValid(), FreeSpaceLogicalToDisplay(), FreeSpaceLogicalToOdbc(), FreeSpaceNormalize(), FreeSpaceSet()
property SysBGTaskId as %String;
Property methods: SysBGTaskIdDisplayToLogical(), SysBGTaskIdGet(), SysBGTaskIdIsValid(), SysBGTaskIdLogicalToDisplay(), SysBGTaskIdLogicalToOdbc(), SysBGTaskIdNormalize(), SysBGTaskIdSet()
property disabledStyle as %ZEN.Datatype.style [ InitialExpression = "background-image:none;background:#D0D0D0;cursor: not-allowed;" ];
Style applied to buttons when automatically disabled.
Property methods: disabledStyleDisplayToLogical(), disabledStyleGet(), disabledStyleIsValid(), disabledStyleLogicalToDisplay(), disabledStyleLogicalToOdbc(), disabledStyleNormalize(), disabledStyleSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method DrawAbortError(seed As %String) as %Status [ Language = objectscript ]
classmethod GetFreeSpace(Directory As %String, Output FreeSpace As %Integer, Output EndFree As %Integer, Output CurrSize As %Integer) as %String [ Language = objectscript ]
Return available FreeSpace
classmethod StartCompact(DBName, Directory, Target) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
Start background job to compact a selected directory
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod 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.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod validate(target, sizemin, sizemax) as %Boolean [ Language = javascript ]
Make sure that the Target size is smaller than that of the current available freespace

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)