com.sap.tc.col.client.generic.api
Interface IMessage

public interface IMessage

interface for GCP Messages. GCP only wraps ISrvMgrMessage object from ServiceManagerFrontend

Field Summary

static int	ERROR
static int	INFO
static int	WARNING

Method Summary

java.lang.String	getAspectFieldName()
java.lang.String	getAspectName() returns the name of the Aspect, this message is associated to or null, if the message doesn't correspond to an Aspect.
IAspectRow	getAspectRow() Deprecated. from Beta4 on, there is no unique AspectRow instance associated to a Message
IKey	getAspectRowKey() returns the Key of the AspectRow this message is associated to, or null, if this message is no AspectRow message.
java.lang.String	getCode() Returns the code part of this message consisting of message id and message number.
java.lang.Object	getExtension() Returns the backend defined extension object of this message or null if none has been provided (empty String?).
java.lang.String	getText() Returns the text part of this message.
int	getType() Returns the type of this message.
java.lang.String[]	getVars() Returns the values of message parameters as specified when creating this message.
boolean	isAspectRowMessage() Returns true, if this Message is an AspectRow message or null otherwise.
boolean	isError() Returns true, if message has type ERROR
boolean	isFailed() Returns true if this message indicates that the processing in the backend has failed.
boolean	isInfo() Returns true, if message has type INFO
boolean	isSystemMessage() Returns true, if this Message is a system message or null otherwise.
boolean	isSystemMessageConfirm() Returns true, if this Message is a system message confirm or null otherwise.
boolean	isWarning() Returns true, if message has type WARNING

Field Detail

INFO

public static final int INFO

WARNING

public static final int WARNING

ERROR

public static final int ERROR

Method Detail

getType

public int getType()

Returns the type of this message. Always one of INFO, WARNING or ERROR.

isInfo

public boolean isInfo()

Returns true, if message has type INFO

Returns:

boolean true, if message has type INFO.

isWarning

public boolean isWarning()

Returns true, if message has type WARNING

Returns:

boolean true, if message has type WARNING.

isError

public boolean isError()

Returns true, if message has type ERROR

Returns:

boolean true, if message has type ERROR.

isFailed

public boolean isFailed()

Returns true if this message indicates that the processing in the backend has failed.

Note that this is only a hint to the caller. The only guaranteed constraint is, that isFailed() returns false for types INFO and WARNING.

Returns:

boolean true if the backend failed to process the originating call.

getCode

public java.lang.String getCode()

Returns the code part of this message consisting of message id and message number.

getText

public java.lang.String getText()

Returns the text part of this message. The text is already expanded, that is if the corresponding message in the backend contained parameters, then these parameters have already bee nreplaced by the concrete values as returned by getVars().

getExtension

public java.lang.Object getExtension()

Returns the backend defined extension object of this message or null if none has been provided (empty String?).

isSystemMessage

public boolean isSystemMessage()

Returns true, if this Message is a system message or null otherwise. System messages are messages not bound to a special AspectRow, but they may be associated to an Aspect.

Returns:

true, if this Message is a system message or null otherwise.

isSystemMessageConfirm

public boolean isSystemMessageConfirm()

Returns true, if this Message is a system message confirm or null otherwise. System messages confirm are messages not bound to a special AspectRow, but they may be associated to an Aspect. with different life time (user has to confirm this type of message explicitly). This category is not used in the moment.

Returns:

true, if this Message is a system message confirm or null otherwise.

isAspectRowMessage

public boolean isAspectRowMessage()

Returns true, if this Message is an AspectRow message or null otherwise. AspectRow messages are messages bound directly to a special AspectRow (not the instance, but Key / Aspect Name)

Returns:

true, if this Message is an AspectRow message or null otherwise.

getAspectRow

public IAspectRow getAspectRow()

Deprecated. from Beta4 on, there is no unique AspectRow instance associated to a Message

returns the AspectRow instance, this Message is associated to. From Beta4 on, you only get an AspectRow not equal null, if you have created the MessageList with IAspectRow.getMessages().

Returns:

the AspectRow instance, this Message is associated to

getAspectFieldName

public java.lang.String getAspectFieldName()

getAspectRowKey

public IKey getAspectRowKey()

returns the Key of the AspectRow this message is associated to, or null, if this message is no AspectRow message.

Returns:

the Key of the AspectRow this message is associated to

getAspectName

public java.lang.String getAspectName()

returns the name of the Aspect, this message is associated to or null, if the message doesn't correspond to an Aspect.

Returns:

String the name of the Aspect, this message is associated to

getVars

public java.lang.String[] getVars()

Returns the values of message parameters as specified when creating this message. If no parameters have been specified, an empty array (String[0]) is returned.