Skip to main content

%CSP.UI.Portal.Dialog.ArchiveWizard

class %CSP.UI.Portal.Dialog.ArchiveWizard extends %CSP.UI.Portal.Dialog.WizardTemplate

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Dialog.ArchiveWizard.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 EMSSERVICE = Namespace;
parameter HELPADDRESS = System Administration, Configuration, System Configuration, Archive Target Settings, Add Archive Target;
parameter PAGENAME = Edit Archive Target;
Displayed name of this page.
parameter RECENT = 0;
parameter RESOURCE = %Admin_Manage;
Security requirement

Properties

property IsEditForm as %Boolean [ InitialExpression = 1 ];
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()
property PID as %String (ZENURL = "PID");
Archive for edit. Null if adding new archive.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property isNew as %String (ZENURL = "isNew") [ InitialExpression = "1" ];
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewNormalize(), isNewSet()

Methods

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 SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, pPID As %String) [ ZenMethod ]
Used to Save tableNavBar values, add PID to the page name to distinguish the type for the page.
clientmethod changeType(newvalue) [ Language = javascript ]
clientmethod doModified(newvalue) [ Language = javascript ]
clientmethod doSave() as %Boolean [ Language = javascript ]
Process save and create new archive. Return true if success. OW return false.
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 getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
Overriden to add PID to the page name to distinguish the specific page.
Overriden to add PID to the page name to distinguish the specific page.
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 validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab