com.sap.tc.cmi.messages

Interface ICMIMessage02

All Superinterfaces:

ICMIMessage

public interface ICMIMessage02
extends ICMIMessage

Enhanced message that also supports a (potentially formatted) long text.

Since:

NWNY SP3

Type Classification:

This interface is part of the Common Model Interface and is intended to be implemented by applications.

Field Summary

Fields inherited from interface com.sap.tc.cmi.messages.ICMIMessage

NO_PARAMETERS

Method Summary

CMITextFormat	getFormatOfLongText() Format of the text returned by getLongText() or null if no long text exists.
String	getLongText() Longer (more descriptive) version of the message text in a default locale.

Methods inherited from interface com.sap.tc.cmi.messages.ICMIMessage

getLifetime, getMessageKey, getParameters, getSeverity, getText, getText, getTextPattern, isObjectRelated, isProcessed, markAsProcessed

Method Detail

getFormatOfLongText

CMITextFormat getFormatOfLongText()

Format of the text returned by getLongText() or null if no long text exists.

As the long text is already expanded, JAVA_MESSAGE_FORMAT makes no sense and if the format is SAP_XHTML, then the long text should not contain the <field/> tag.

Returns:

format of the long text or null if no text exists.

getLongText

String getLongText()

Longer (more descriptive) version of the message text in a default locale. All parameters are already resolved and expanded.

Implementations should return null, if they can't produce a long text version of a message. They should not return the short message text.

The long text might contain some markup. See getFormatOfLongText() for details.

Returns:

long text version of the message or null.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api	api	BC-JAS-EJB
[sap.com] FRAMEWORK	[sap.com] tc/cmi	default	BC-WD-JAV-RUN