DocBook|Search
Class Reference
%cspapp.mgr.utilsysecp
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [USER] >  [%cspapp] >  [mgr] >  [utilsysecp]
Private  Storage  

class %cspapp.mgr.utilsysecp extends %CSP.UI.System.AutoPageCSP

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 7


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%OriginalNamespace %PackageName ConvertParameter Decrypt
ECPEnabled Encrypt EscapeHTML EscapeURL
GetLocator GetPageName HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnHTTPHeader
OnPage OnPageBODY OnPageCSPROOT OnPageError
OnPageHEAD OnPageHTML OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL WriteTitlePane


Parameters

• parameter CSPFILE = "F:\705\dev\databases\sys\csp\app\mgr\UtilSysECP.csp";
If this page was compiled from a .csp file, then this parameter contains the filename used for compilation.
• parameter CSPURL = "/csp/sys/mgr/UtilSysECP.csp";
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 FileTimestamp = "62754,64989";
• parameter PAGENAME = "ECP Settings";
Name of this page
• parameter PARENTPAGE = "UtilConfigHome.csp";
Name of the parent page (used for the locator bar)

Methods

• classmethod ECPEnabled() as %String
• classmethod OnPage() as %Status
Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
• classmethod OnPageBODY() as %Boolean
• classmethod OnPageCSPROOT() as %Boolean
• classmethod OnPageHEAD() as %Boolean
• classmethod OnPageHTML() as %Boolean
• classmethod OnPreHTTP() as %Boolean
Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage from being called.