Skip to main content

EnsPortal.ServiceRegistry.Dialog.FileImport

Property Inventory

Method Inventory

Parameters

parameter CSSINCLUDES = ensemble/Ensemble_Wizards.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 File;
Displayed name of this page.

Properties

property FileName as %ZEN.Datatype.string (ZENURL = "NAME");
Used when returning to dialog from import of a local file
Property methods: FileNameDisplayToLogical(), FileNameGet(), FileNameIsValid(), FileNameLogicalToDisplay(), FileNameLogicalToOdbc(), FileNameNormalize(), FileNameSet()
property INPUTTYPE as %ZEN.Datatype.string (ZENURL = "INPUTTYPE");
If true, then this dialog displays an Apply button.
Property methods: INPUTTYPEDisplayToLogical(), INPUTTYPEGet(), INPUTTYPEIsValid(), INPUTTYPELogicalToDisplay(), INPUTTYPELogicalToOdbc(), INPUTTYPENormalize(), INPUTTYPESet()
property Key as %ZEN.Datatype.string (ZENURL = "KEY");
Property methods: KeyDisplayToLogical(), KeyGet(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property Registry as %ZEN.Datatype.string (ZENURL = "REGISTRY") [ Final ];
Property methods: RegistryDisplayToLogical(), RegistryGet(), RegistryIsValid(), RegistryLogicalToDisplay(), RegistryLogicalToOdbc(), RegistryNormalize(), RegistrySet()
property Service as %ZEN.Datatype.string (ZENURL = "SVC");
Property methods: ServiceDisplayToLogical(), ServiceGet(), ServiceIsValid(), ServiceLogicalToDisplay(), ServiceLogicalToOdbc(), ServiceNormalize(), ServiceSet()
property canViewFileSystem as %Boolean [ Final , InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property retValue as %String;
Return value from this dialog
Property methods: retValueDisplayToLogical(), retValueGet(), retValueIsValid(), retValueLogicalToDisplay(), retValueLogicalToOdbc(), retValueNormalize(), retValueSet()

Methods

method %OnAfterCreatePage() as %Status
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
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 %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This method is invoked only when user selects to import from Local Machine.
The necessary parameters are passed in URL. The temp file name is saved in %session and to be used in loading content.
classmethod GetDefaultDir() as %String [ ZenMethod ]
method GetDeleteStatus() as %String [ ZenMethod ]
method GetImportStatus() as %String [ ZenMethod ]
method GetLikelyValues(pFilePath) [ ZenMethod ]
method IsNameUnique(pID As %String) as %Boolean [ ZenMethod ]
method IsNameValid(pName As %String) as %Boolean [ ZenMethod ]
Test if the given name is valid.
method PerformImport(pFilePath, pNewName, pMIMEType, pCharSet) as %String [ ZenMethod ]
classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]
classmethod ValidateFile(FILE) as %Integer [ ZenMethod ]
Validate file name.
clientmethod browseSelect(name) [ Language = javascript ]
User clicked the Browse button.
clientmethod doImport() [ Language = javascript ]
Start the Import
clientmethod doLocationChange(flag) [ Language = javascript ]
User changed to pick file between Remote and Local
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 onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select and setting the value into the appropriate field.
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 ]
This client event, if present, is fired when the page is loaded.
clientmethod selectLocalFile() [ Language = javascript ]
clientmethod selectRemoteFile() [ Language = javascript ]
clientmethod validateName() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab