public interface IMessage
Modifier and Type | Field and Description |
---|---|
static int |
CATEGORY_OBJECT |
static int |
CATEGORY_PROCESS |
static int |
LIFETIME_ONCE |
static int |
LIFETIME_ONCE_TRX |
static int |
LIFETIME_PERMANENT |
static int |
TYPE_ERROR |
static int |
TYPE_INFO |
static int |
TYPE_SUCCESS |
static int |
TYPE_WARNING |
Modifier and Type | Method and Description |
---|---|
int |
getCategory()
Returns the category of the message.
|
String |
getGuid()
Returns a generated unique ID to identify the message.
|
int |
getLifeTime()
Returns the life time of the message.
|
String |
getLocalizedMessage(Locale locale)
Returns the localized message text.
|
String |
getMessage()
Returns a not localized clear text which might be assigned to the
message, or
null . |
Date |
getTimeStamp()
Returns the
java.util.Date object that represents the time
when the message was added to the message buffer. |
int |
getType()
Returns the type of the message.
|
static final int TYPE_ERROR
static final int TYPE_WARNING
static final int TYPE_INFO
static final int TYPE_SUCCESS
static final int LIFETIME_PERMANENT
static final int LIFETIME_ONCE
static final int LIFETIME_ONCE_TRX
static final int CATEGORY_OBJECT
static final int CATEGORY_PROCESS
String getLocalizedMessage(Locale locale)
getMessage()
) which is not a translated text
and not related to the given locale object.locale
- The locale for which the text should be returned.int getType()
TYPE_ERROR
,TYPE_WARNING
,
TYPE_INFO
,TYPE_SUCCESS
TYPE_ERROR
means: The message text explains an error.
TYPE_WARNING
means: The message text explains a warning.
TYPE_INFO
means: The message text is informational.
TYPE_SUCCESS
means: The message text explains a
successfully completed operation. This type is not in use.int getLifeTime()
LIFETIME_PERMANENT
,LIFETIME_ONCE
,
LIFETIME_ONCE_TRX
LIFETIME_PERMANENT
means: Message is valid until explicitly deleted. This is the default for
all messages. LIFETIME_ONCE
means: Message is valid only
once. After it has been displayed once, it should not appear again.
LIFETIME_ONCE_TRX
means: Message is only valid in the
current transaction. This life time is not in use.int getCategory()
CATEGORY_OBJECT
,CATEGORY_PROCESS
CATEGORY_OBJECT
means: The message is related to a
specific IPrincipal object. CATEGORY_PROCESS
means: The
message is realted to a process (like search).Date getTimeStamp()
java.util.Date
object that represents the time
when the message was added to the message buffer.String getMessage()
null
. This message is used to enrich the
localized generic message (getLocalizedMessage(Locale)
.null
String getGuid()
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] CORE-TOOLS
|
[sap.com]
|
default
|
BC-JAS
|
[sap.com] ENGFACADE
|
[sap.com] tc/je/usermanagement/api
|
api
|
BC-JAS-SEC
|
[sap.com] ENGINEAPI
|
[sap.com]
|
-
|
BC-JAS-SEC-UME
|
[sap.com] ENGINEAPI
|
[sap.com]
|
default
|
BC-JAS-SEC-UME
|
Copyright 2018 SAP AG Complete Copyright Notice