%CSP.UI.Portal.Applications.DocDB

class %CSP.UI.Portal.Applications.DocDB extends %CSP.UI.Portal.Template

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTONS = 0;
Do not switch namespace for this page: it needs to stay in %SYS
parameter CSPURL = /csp/sys/sec/%CSP.UI.Portal.Applications.DocDB.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 = Security;
parameter HELPADDRESS = System Administration,Security,Applications,Edit Doc DB Application;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = Edit Doc DB;
Displayed name of this page.
parameter PARENTPAGE = /csp/sys/sec/%CSP.UI.Portal.Applications.DocDBList.zen;
Inherited description: 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.
parameter RECENT = 0;
Inherited description: If true, register visits to this page in the recent list.
parameter RESOURCE = %Admin_Secure;
Security requirement

Properties (Including Private)

property IsEditForm as %Boolean [ InitialExpression = 1 ];
Inherited description: If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.
Property methods: IsEditFormDisplayToLogical(), IsEditFormGet(), IsEditFormIsValid(), IsEditFormLogicalToDisplay(), IsEditFormLogicalToXSD(), IsEditFormNormalize(), IsEditFormSet(), IsEditFormXSDToLogical()

Methods (Including Private)

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page. Subclass can override.
classmethod SaveData(pProxy As %ZEN.proxyObject) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
Call server save method.
clientmethod doSave() [ Language = javascript ]
Save current item.
clientmethod getPageTitle() as %String [ Language = javascript ]
Get the title string to add to the locator row.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages. Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod selectChanged(which, newVal) [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window