Class EnsPortal.ServiceRegistry.Dialog.FileImport

hidden class EnsPortal.ServiceRegistry.Dialog.FileImport extends EnsPortal.Dialog.standardDialog

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	7	23

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	FileName	FirstFailed	INPUTTYPE
InvalidParam	IsEMSReadOnly	Key	Registry
Service	ValidationErrorMsg	align	aux
backgroundTimerInterval	canEdit	canViewFileSystem	cellAlign
cellSize	cellStyle	cellVAlign	children
closeOnEnter	closeOnEsc	composite	containerStyle
cssLevel	dialogTitle	disabled	disabledStyle
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	groupClass	groupStyle
hasButtons	height	hidden	hideApplyButton
hideCancelButton	hideOKButton	hint	hintClass
hintStyle	id	index	keepAliveInterval
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	msgNotPermitted	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	parent	retValue	showLabel
slice	studioMode	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%AddImportedComponents	%AddToSaveSet
%ApplyURLParms	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%DrawTitle	%EnclosingDivId	%EndBackgroundMethod	%EndScript
%Eval	%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetComponent	%GetComponentById	%GetComponentByName
%GetEventHandlers	%GetLinks	%GetPageName	%GetParameter
%GetValueById	%GetValueByName	%GetXMLName	%IsA
%IsModified	%Link	%LinkCSS	%LinkScript
%MakeId	%New	%NormalizeObject	%ObjectModified
%OnAddToPageAfter	%OnAddToPageBefore	%OnAfterCreatePage	%OnBeforeCreatePage
%OnCreateApplication	%OnCreatePage	%OnDetermineCSSLevel	%OnDrawEnclosingDiv
%OnDrawHTMLBody	%OnDrawHTMLHead	%OnDrawHTMLMeta	%OnDrawObjectProperties
%OnFinishBackgroundTask	%OnGetSubtitle	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%RemoveChild	%RemoveChildren
%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod	%Self
%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById	%SetErrorByName
%SetModified	%SetValueById	%SetValueByName	%SetValuesByName
%StartScript	%ValidateObject	%ZENVersion	ConvertParameter
Decrypt	Encrypt	EscapeHTML	EscapeURL
EvalResult	GetDefaultDir	GetDeleteStatus	GetHyperEventResources
GetImportStatus	GetLikelyValues	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsNameUnique
IsNameValid	IsPrivate	JavaInstalled	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PerformImport	QuoteJS	RewriteURL	SetDefaultDir
ShowError	SimpleKeepAlive	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	ValidateFile
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addPopupSuffix
adjustSize	browseSelect	btnApply	btnOK
cancelPopup	checkEdit	childrenMutated	clientKeepAlive
correctIELayering	createComponent	createComponentNS	ctrlKeyDown
deleteComponent	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	doImport	doLocationChange
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getDialogValue	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getType	gotoPage	inResizeLoop	initPopupSuffix
invokeSuper	isOfType	launchPopupWindow	makeId
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onServerMethodCall
onServerMethodError	onServerMethodReturn	onStartModalHandler	ondialogCancel
ondialogFinish	ondialogStart	ondisabledHandler	onhandleAutoLogoutWarn
onkeydownHandler	onkeyupHandler	onlayoutHandler	onloadHandler
onlogoutHandler	onoverlayHandler	onresizeHandler	onunloadHandler
onupdateHandler	popupActionHandler	refreshContents	removeChild
removePopupSuffix	render	renderContents	renderSVG
resetMsg	selectLocalFile	selectRemoteFile	setComponentId
setHidden	setOverlayMode	setProperty	setPropertyAll
setTraceOption	showMsg	startKeepAlive	startModal
startProgressBar	stopKeepAlive	stopProgressBar	validateName
validateRequired

Parameters

• parameter CSSINCLUDES = "ensemble/Ensemble_Wizards.css";

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 INPUTTYPE as %ZEN.Datatype.string(ZENURL="INPUTTYPE");

If true, then this dialog displays an Apply button.

• property Key as %ZEN.Datatype.string(ZENURL="KEY");

• property Registry as %ZEN.Datatype.string(ZENURL="REGISTRY") [ Final ];

• property Service as %ZEN.Datatype.string(ZENURL="SVC");

• property canViewFileSystem as %Boolean [ Final,InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup.

• property retValue as %String;

Return value from this dialog

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.

• method browseSelect(name) [ Language = javascript ]

User clicked the Browse button.

• method doImport() [ Language = javascript ]

Start the Import

• method doLocationChange(flag) [ Language = javascript ]

User changed to pick file between Remote and Local

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Returning from file select and setting the value into the appropriate field.

• method 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.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method selectLocalFile() [ Language = javascript ]

• method selectRemoteFile() [ Language = javascript ]

• method validateName() as %Boolean [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search