Class sap.apf.core.MessageObjectModule: sap/apf/core/messageObject

The message object represents the APF specific message object for detailed evaluation. The message object shall be created by method sap.apf.Api#createMessageObject.

Constructor Summary
new sap.apf.core.MessageObject(oConfig)
Method Summary
getCallingObject()Returns the calling object
getCode()Returns the message code.
getJQueryVersion()Returns the version of jQuery
getMessage()Returns the message text.
getParameters()Returns the parameter which were passed over
getPrevious()Gets the previous message object.
getRawText()Returns raw text.
getSapUi5Version()Returns the version of SAP UI5
getSeverity()Returns the severity.
getStack()Returns the stack of the error object to get the line number and source file
getTimestamp()Returns the time stamp of the message object in seconds after 1970
getTimestampAsdateObject()Returns the time stamp of the message object as a date
hasRawText()Returns true, if a raw text is set.
setCode(code)Sets the code, that classifies the message.
setMessage(sTextMessage)Sets the message text.
setPrevious(oPreviousMessageObject)Sets the previous message object.
setSeverity(severity)Sets the severity , which classifies the message.
Constructor Detail
new sap.apf.core.MessageObject(oConfig)
Parameters:
{object}oConfig
Method Detail
getCallingObject(): object
Returns the calling object
Returns:
{object}
getCode(): string
Returns the message code.
Returns:
{string}
getJQueryVersion(): string
Returns the version of jQuery
Returns:
{string}
getMessage(): string
Returns the message text.
Returns:
{string}
getParameters(): array
Returns the parameter which were passed over
Returns:
{array}
getPrevious(): sap.apf.core.MessageObject
Gets the previous message object.
Returns:
{sap.apf.core.MessageObject} || undefined
getRawText(): string
Returns raw text.
Returns:
{string}
getSapUi5Version(): string
Returns the version of SAP UI5
Returns:
{string}
getSeverity(): string
Returns the severity.
Returns:
{string}
getStack(): string
Returns the stack of the error object to get the line number and source file
Returns:
{string}
getTimestamp(): number
Returns the time stamp of the message object in seconds after 1970
Returns:
{number}
getTimestampAsdateObject(): date
Returns the time stamp of the message object as a date
Returns:
{date}
hasRawText(): boolean
Returns true, if a raw text is set.
Returns:
{boolean}
setCode(code)
Sets the code, that classifies the message.
Parameters:
{string}code
setMessage(sTextMessage)
Sets the message text.
Parameters:
{string}sTextMessage
setPrevious(oPreviousMessageObject)
Sets the previous message object. One can add a message object to this message object, that describes a previous message. The message in the previous message object will also be displayed in the log (as previous entry).
Parameters:
{sap.apf.core.MessageObject}oPreviousMessageObject
setSeverity(severity)
Sets the severity , which classifies the message.
Parameters:
{string}severity Only for to build in error messages. Allowed values are defined in sap.apf.constants.severity.