Error Class Reference

This error page will display information that is designed to make debugging an application easier, if you deploy a CSP application then you should use the <class>CSP.ErrorLog</class> error page that logs the information or your own error that displays an error message suitable for an end user rather than providing them with a lot of debug information. More...

Inheritance diagram for Error:

Collaboration diagram for Error:

Static Public Member Functions
_.Library.Status	DisplayError (_.Library.String ErrorInfo)
	Output in HTML the error information in ErrorInfo which is the array provided by. More...
	HyperEventError ()
	If an error occurs while processing a HyperEvent then this method is called. More...
_.Library.Status	OnPage ()
	Output the error page as HTML. More...
Static Public Member Functions inherited from ErrorLog
_.Library.String	ClassifyError (err)
	Classify if this is an expected error like a page not found and if so return the response.Status information. More...
_.Library.Status	DecomposeError (_.Library.Status sc, _.Library.String ErrorInfo)
	Return an array of information in ErrorInfo about the error suitable for display with a. More...
	LogError ()
	Dump all information to local arrays and call ETN to log this error.
_.Library.Boolean	OnErrorSetup (_.Library.Boolean skipheader)
	This is called before the OnPreHTTP and will handle the HyperEvent errors and. More...
Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...
_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...
_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...
_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.
_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...
_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...
_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...
	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...
_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...
_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...
_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).
_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...
_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...
	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...
	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...
_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.
_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. More...
_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...
_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...
_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.
_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.
	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.
	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...
	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...
	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.
_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.
_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Additional Inherited Members
Static Public Attributes inherited from ErrorLog
	LICENSEERRORPAGE = None
	This is the default CSP error page. More...
	OTHERSTATICERRORPAGE = None
	If the user with a new session goes to a page that causes an error before a license is obtained then in order to. More...
	PAGENOTFOUNDERRORPAGE = None
	If the user with a new session goes to a page that is not present then in order to display the standard error page. More...
	PRIVATE = None
	Error pages should be private to avoid the chance the user can go to them. More...
Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...
	CONTENTTYPE = None
	Specifies the default content type for the page. More...
	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...
	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...
	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...
	CSPURL = None
	This parameter is used to make sure that if multiple. More...
	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...
	DOMAIN = None
	The default domain for csp:text, span and div tags. More...
	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...
	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...
	EXPIRES = None
	Specified the default value for the response.Expires. More...
	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...
	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...
	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...
	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...
	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...
	UseSession = None
	This parameter controls the CSP session support. More...

Detailed Description

This error page will display information that is designed to make debugging an application easier, if you deploy a CSP application then you should use the <class>CSP.ErrorLog</class> error page that logs the information or your own error that displays an error message suitable for an end user rather than providing them with a lot of debug information.

Member Function Documentation

DisplayError()

_.Library.Status DisplayError ( _.Library.String  ErrorInfo )

static

Output in HTML the error information in ErrorInfo which is the array provided by.

<method>DecomposeError</method>.

HyperEventError()

HyperEventError ( )

static

If an error occurs while processing a HyperEvent then this method is called.

This method will write out javascript code that will be executed on the browser. Note that the variable 'CSPPage' refers to the 'self' of the page on which the Hyperevent was called as this may be different to the current 'self'.

You could use this javascript to redirect the browser to another page:

Write "CSPPage.window.location='/csp/samples/menu.csp';",!

Or you could popup an alert box with the error message in it:

Write "alert('An error occurred');",!

Reimplemented from ErrorLog.

Reimplemented in LogError.

OnPage()

_.Library.Status OnPage ( )

static

Output the error page as HTML.

This makes use of the ##class(CSP.Utils).DisplayAllObjects()

call to display as much information as possible about the state of the request, response, server objects when the error occurred.

Reimplemented from ErrorLog.

Reimplemented in StudioTemplateError, and LogError.