oracle.alm.common.message

Class AlmMessage

java.lang.Object

oracle.alm.common.message.AlmMessage

All Implemented Interfaces:

java.io.Serializable

public class AlmMessage
extends java.lang.Object
implements java.io.Serializable

The AlmMessage is the class to configure a message to be shown to end user through TPC IDE client. The message is be configured in TPC connector code.

An AlmMessage is different from an ALMException. It only logs a message, not likes throwing an ALMException will result the interruption of the code execution .

Please refer to ClientRequestContext to see example.

Since:

11.1.1.1.0

See Also:

AlmMessageFactory, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlmMessage.Severity Inner class to define the severity of the message.

Field Summary

Fields

Modifier and Type	Field and Description
static AlmMessage.Severity	SEVERITY_ERROR
static AlmMessage.Severity	SEVERITY_FATAL
static AlmMessage.Severity	SEVERITY_INFO
static AlmMessage.Severity	SEVERITY_WARN
static java.util.List	VALUES
static java.util.Map	VALUES_MAP

Constructor Summary

Constructors

Constructor and Description
AlmMessage() Constructs a blank message.
AlmMessage(AlmMessage.Severity severity, java.lang.String summary, java.lang.String detail) Constructs a message with the specified severity level, summary and detail information.
AlmMessage(java.lang.String summary) Constructs a message with the specified summary.
AlmMessage(java.lang.String summary, java.lang.String detail) Constructs a message with the specified summary and detail.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDetail() Retrieves the message detail.
AlmMessage.Severity	getSeverity()
java.lang.String	getSummary() Retrieves the message summary.
void	setDetail(java.lang.String detail) Sets the message detail.
void	setSeverity(AlmMessage.Severity severity) Sets the message severity.
void	setSummary(java.lang.String summary) Sets the message summary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEVERITY_INFO

public static final AlmMessage.Severity SEVERITY_INFO

SEVERITY_WARN

public static final AlmMessage.Severity SEVERITY_WARN

SEVERITY_ERROR

public static final AlmMessage.Severity SEVERITY_ERROR

SEVERITY_FATAL

public static final AlmMessage.Severity SEVERITY_FATAL

VALUES

public static final java.util.List VALUES

VALUES_MAP

public static final java.util.Map VALUES_MAP

Constructor Detail

AlmMessage

public AlmMessage()

Constructs a blank message. The Severity level is set to SEVERITY_INFO.

AlmMessage

public AlmMessage(java.lang.String summary)

Constructs a message with the specified summary. The Severity level is set to SEVERITY_INFO.

Parameters:

summary - the summary of the message

AlmMessage

public AlmMessage(java.lang.String summary,
          java.lang.String detail)

Constructs a message with the specified summary and detail. The severity level is set to SEVERITY_INFO.

Parameters:

summary - summary of the message

detail - detail content of the message

AlmMessage

public AlmMessage(AlmMessage.Severity severity,
          java.lang.String summary,
          java.lang.String detail)

Constructs a message with the specified severity level, summary and detail information.

Parameters:

severity - The servierity level. Valid values are: AlmMessage.SEVERITY_ERROR, AlmMessage.SEVERITY_FATAL, AlmMessage.SEVERITY_INFO, AlmMessage.SEVERITY_WARN

summary - summary of the message

detail - detail content of the message

Method Detail

getSeverity

public AlmMessage.Severity getSeverity()

Returns:

the Severity of the message.

setSeverity

public void setSeverity(AlmMessage.Severity severity)

Sets the message severity.

Parameters:

severity - the Severity of the message

getSummary

public java.lang.String getSummary()

Retrieves the message summary.

Returns:

the summary information of the message

setSummary

public void setSummary(java.lang.String summary)

Sets the message summary.

Parameters:

summary - Summary of the message

getDetail

public java.lang.String getDetail()

Retrieves the message detail.

Returns:

the detail content of a message

setDetail

public void setDetail(java.lang.String detail)

Sets the message detail.

Parameters:

detail - the detail content of the message