Class %CSP.UI.Portal.Config.RemoteDatabase

class %CSP.UI.Portal.Config.RemoteDatabase extends %CSP.UI.Portal.AdvancedSettingsTemplate

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	2	16

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	Category	HelpAddress	ISREADONLY
LocatorHeader	PID	ParentURL	SelectedServer
StdTitle	Subject	aboutPage	align
aux	backgroundTimerInterval	cellAlign	cellSize
cellStyle	cellVAlign	children	composite
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	isNew
label	labelClass	labelDisabledClass	labelPosition
labelStyle	layout	lblTitle	msgNoSubject
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	pageModified	parent
searchKey	showLabel	slice	title
tuple	useSVG	useSoftModals	valign
valueModified	visible	width	window
zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet
%ApplyURLParms	%Attr	%BindExport	%ClassIsLatestVersion
%ClassName	%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML
%DrawHTML	%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetPageName
%GetParameter	%GetProductName	%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	%OnGetPageName
%OnGetProductName	%OnGetSmallMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	CheckAllBlanks	CheckDBName	ConvertParameter
Decrypt	DeleteData	DoLogout	DrawAfterCreatePage
DrawLocator	DrawLocatorExtra	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetCSPURL	GetClassName	GetContextLinks	GetDocPage
GetHomePage	GetNames	GetNewURL	GetPropertyList
GetQuickLinks	HyperEventBody	HyperEventCall	HyperEventFrame
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RemoteDatabaseListClose	RemoteDatabaseListExecute
RemoteDatabaseListFetch	RewriteURL	SaveData	ShowError
StartTimer	StopTimer	SubHelpPath	ThrowError
UnescapeHTML	UnescapeURL	UpdateDetails	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	ZStripW
addChild	addChildAfter	addChildBefore	cancelItem
cancelPopup	changeDirectory	changePassword	changeSelectList
changeServer	childrenMutated	correctIELayering	createComponent
createComponentNS	deleteComponent	deleteItem	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	editItem	endModal	exposeComponent
findElement	fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getEnclosingDiv	getHidden	getHintElement
getLabelElement	getOpener	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	helpItem	invokeSuper
isOfType	launchPopupWindow	logout	makeId
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
refreshTable	removeChild	render	renderContents
renderSVG	resetMsg	saveItem	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setHidden	setModified	setOverlayMode
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	showAbout
showDocumentation	showHelp	showHideComponent	showMsg
startModal	startProgressBar	stopProgressBar	switchNamespace
validate	validateRange	validateRequired	valueChanged

Parameters

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Config.RemoteDatabase.cls";

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 = "Remote Database";

Displayed name of this page.

• parameter PARENTPAGE = "%CSP.UI.Portal.Config.RemoteDatabases.cls";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

Properties

• property PID as %String(ZENURL="PID");

Database for edit. Null if adding new database.

• property SelectedServer as %String;

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Subclass can override.

• classmethod CheckDBName(Name As %String) as %Boolean [ ZenMethod ]

Return 1 if the database name is OK

• classmethod GetPropertyList(Subject As %String) as %String

• classmethod SaveData(Subject, PID, Name, Properties, Values) as %String [ ZenMethod ]

Call server save method. Subclass may override.

• method cancelItem() [ Language = javascript ]

Cancel current Items.

• method changeDirectory(dataCombo) [ Language = javascript ]

• method changeSelectList(radioSet) [ Language = javascript ]

• method changeServer(dataCombo) [ Language = javascript ]

• method onloadHandler() [ Language = javascript ]

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

• method saveItem() [ Language = javascript ]

Save current item. Subclass to override.

• method showHideComponent(id, hidden) [ Language = javascript ]

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


[BASEXML] > [%CSP] > [UI] > [Portal] > [Config] > [RemoteDatabase]		Private Storage