|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 1 (11.1.1.7.0) E14128-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.alm.common.message.AlmMessage
public class AlmMessage
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.
Nested Class Summary | |
---|---|
static class |
AlmMessage.Severity
Inner class to define the severity of the message. |
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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 |
---|
public static final AlmMessage.Severity SEVERITY_INFO
public static final AlmMessage.Severity SEVERITY_WARN
public static final AlmMessage.Severity SEVERITY_ERROR
public static final AlmMessage.Severity SEVERITY_FATAL
public static final java.util.List VALUES
public static final java.util.Map VALUES_MAP
Constructor Detail |
---|
public AlmMessage()
Constructs a blank message. The Severity level is set to SEVERITY_INFO.
public AlmMessage(java.lang.String summary)
Constructs a message with the specified summary. The Severity level is set to SEVERITY_INFO.
summary
- the summary of the messagepublic 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.
summary
- summary of the messagedetail
- detail content of the messagepublic AlmMessage(AlmMessage.Severity severity, java.lang.String summary, java.lang.String detail)
Constructs a message with the specified severity level, summary and detail information.
severity
- The servierity level. Valid values are:
AlmMessage.SEVERITY_ERROR, AlmMessage.SEVERITY_FATAL,
AlmMessage.SEVERITY_INFO, AlmMessage.SEVERITY_WARNsummary
- summary of the messagedetail
- detail content of the messageMethod Detail |
---|
public AlmMessage.Severity getSeverity()
public void setSeverity(AlmMessage.Severity severity)
Sets the message severity.
severity
- the Severity of the messagepublic java.lang.String getSummary()
Retrieves the message summary.
public void setSummary(java.lang.String summary)
Sets the message summary.
summary
- Summary of the messagepublic java.lang.String getDetail()
Retrieves the message detail.
public void setDetail(java.lang.String detail)
Sets the message detail.
detail
- the detail content of the message
|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 1 (11.1.1.7.0) E14128-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |