Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.ImportAgents

EnsPortal.Dialog.ImportAgents

class EnsPortal.Dialog.ImportAgents extends EnsPortal.Dialog.standardDialog

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter CSSINCLUDES = ensemble/Ensemble_Wizards.css,ensemble/Ensemble_EDI.css;
Inherited description: Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter PAGENAME = Import Agents;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter RESOURCE = %Ens_Agents:WRITE;
User needs WRITE permissions on the %Ens_Agents resource to view this page.

Properties (Including Private)

property File as %ZEN.Datatype.string (ZENURL = "File");
File that items are being imported from
Property methods: FileDisplayToLogical(), FileGet(), FileIsValid(), FileLogicalToDisplay(), FileLogicalToOdbc(), FileNormalize(), FileSet()
property currentFields as %Integer;
Keeps track of how many fields are currently displaying.
Property methods: currentFieldsDisplayToLogical(), currentFieldsGet(), currentFieldsIsValid(), currentFieldsLogicalToDisplay(), currentFieldsNormalize(), currentFieldsSet(), currentFieldsXSDToLogical()
property fieldCount as %Integer;
Keeps track of where we are in counting fields, so we can create unique field ids.
Property methods: fieldCountDisplayToLogical(), fieldCountGet(), fieldCountIsValid(), fieldCountLogicalToDisplay(), fieldCountNormalize(), fieldCountSet(), fieldCountXSDToLogical()
property incomingData as %ZEN.Datatype.list);
Property methods: incomingDataDisplayToLogical(), incomingDataGet(), incomingDataIsValid(), incomingDataLogicalToDisplay(), incomingDataLogicalToOdbc(), incomingDataNormalize(), incomingDataSet()
property retValue as %ZEN.Datatype.string);
Holder for return value.
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetPageName() as %String
Get the (localized) name of the page.
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 page.
method DrawContent(pSeed As %String) as %Status
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
method GetItemUpdateFromServer() as %String [ ZenMethod ]
Get all the necessary data about the items from the server in one call.
method OnWizardCompletion() as %String [ ZenMethod ]
This method is invoked when the user completes the Wizard pressing "OK". Returns a null string if it succeeds, or an error message otherwise.
method PopulateItemsFromGlobals() as %String
clientmethod addAllGroups(incomingData) [ Language = javascript ]
clientmethod doSelectAll(select) [ Language = javascript ]
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 makeNewRow(incomingData) [ Language = javascript ]
incomingData is a string separated with \u0006 characters that contains the data to use in populating the fields in this row. If not provided, a blank-appearing row (empty of data) is created and returned.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback is called when the user presses the OK button. If this returns false, then the action is canceled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod switchImportTitle(key) [ Language = javascript ]