Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.MessageContents
Private  Storage   

EnsPortal.MessageContents


class EnsPortal.MessageContents extends
%CSP.Page

Utility class for displaying the contents of messages.

You should be able to pass in the following parameters:
HeaderClass=<specific message class> (or Ens.MessageHeader if you are starting from a header)
SourceFile=<normalised_path_to_file>
HeaderId=<ID_of_object>
Transform=<Name of transform to apply to an XML Virtual Document>
SchemaCat=<Schema category to use in constructing DocType (if needed)>

The allowed values for HeaderClass are:
Ens.MessageHeader
Ens.Util.LogBase
Ens.Util.IOLog
Ens.BP.Context
EnsLib.EDI.XML.Document
EnsLib.Workflow.TaskResponse
any child of EnsLib.EDI.Document

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9


Summary


Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
CheckPermissions ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL GetMessages HyperEventCall
HyperEventHead Include Initialize InsertHiddenField
InsertHiddenFields IsPrivate Link OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL writewithoutNonXMLChars


Parameters


• parameter CONTENTTYPE = "text/html";
Default content type
• parameter DOMAIN = "Ensemble";
The default domain for csp:text, span and div tags. This parameter is used to specify the subset of localized messages to be used on this page.
• parameter JSINCLUDES = "ensemble/Ensemble_Utils.js";
Comma-separated list of additional JS include files for the page - for Event Details popup.

Methods


• classmethod CheckPermissions(pClassName As %String = "") as %Status
Check whether the user is permitted to view data contained in the class specified in pClassName. An error indicating a reason will be returned if the user is not permitted to view the contents of the class.
• classmethod GetMessages(messages As %ZEN.proxyObject) as %ZEN.proxyObject
• classmethod Initialize(Output pContentType)
Process the incoming request and correctly initialize the data that will be used to construct the appropriate response.
• classmethod OnPage() as %Status
Render the actual content the user will see.
• 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.
• classmethod writewithoutNonXMLChars(pWriter As %XML.Writer, pObject As %XML.Adaptor, Output pWasChanged As %Boolean = 0) as %Status
Used to strip non XML characters from XML object when writing to current device.