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

%CSP.UI.Portal.Background.Dialog.TaskInfo

class %CSP.UI.Portal.Background.Dialog.TaskInfo extends %CSP.UI.Portal.Dialog.WizardTemplate, %ZEN.Portal.Utils, %CSP.UI.Portal.Background.Utils

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.

Displays Background Task Info dialog for Management Portal.

Property Inventory

Method Inventory

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/%CSP.UI.Portal.Background.Dialog.TaskInfo.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 = BackgroundTaskInfo;
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:
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 NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property SysBGTaskId as %String (ZENURL = "SysBGTaskId");
ID for Systems background task id
Property methods: SysBGTaskIdDisplayToLogical(), SysBGTaskIdGet(), SysBGTaskIdIsValid(), SysBGTaskIdLogicalToDisplay(), SysBGTaskIdLogicalToOdbc(), SysBGTaskIdNormalize(), SysBGTaskIdSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
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 [ 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.
classmethod ActionProcess(pAction As %String, pSysBGTaskId As %String) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
This method invokes method to Cancel/Pause/Resume a background job
method GetJobInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
clientmethod doAction(action) [ Language = javascript ]
This method allows user to cancel the task that is currently in progress
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 ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Close button. If this returns false, then the dialog is not cancelled.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window