|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Message
Provides APIs to create a translatable message. Additionally provides ability create a link on the message as well as flag the message as being of attention type.
A link can be either an:
Additionally, a link will also have an associated label on which the link is created. If such a label is not specified, the diagnostics framework will either use the text of the URL (for external URLs) or the function name (for internal URLs) as the default text.
Nested Class Summary | |
---|---|
static class |
Message.MsgType
Enumeration representing the various message types. |
Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants |
---|
DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status |
Field Summary |
---|
Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.ReportConstants |
---|
ERROR_TYPE_DIAG, ERROR_TYPE_EXEC, MSG_ATTENTION, MSG_NORMAL, SEVERITY_CRITICAL, SEVERITY_WARNING |
Method Summary | |
---|---|
void |
addLinkParameter(NameValue pParam)
Adds a parameter for the link. |
void |
addLinkParameters(NameValueList pParams)
Adds a list of parameters for the link. |
void |
addLinkToken(LinkToken pToken)
Adds a Link Token to this Message |
void |
addLinkTokens(java.util.List<LinkToken> pTokens)
Adds a list Link Token to this Message |
java.lang.String |
getFunctionName()
Gets the function name for the link. |
NameValueList |
getLinkParams()
Gets the list of parameters to be added when creating the link URL |
java.util.List<LinkToken> |
getLinkTokens()
Gets the list of Link Tokens |
DiagConstants.LinkType |
getLinkType()
Gets the link type. |
java.lang.String |
getLinkURI()
Gets the link URI for the link |
Message.MsgType |
getMsgType()
Gets the message type for this message |
void |
setFunctionName(java.lang.String pFunctionName)
Sets the function name for the link. |
void |
setLinkToMetalinkNote(java.lang.String pNoteId)
Sets a link on this message to the given Metalink note ID. |
void |
setLinkType(DiagConstants.LinkType pLinkType)
Sets the link type for the link. |
void |
setLinkURI(java.lang.String pURI)
Sets the URI for the link. |
void |
setMsgType(Message.MsgType pMsgType)
Sets the message type for this message |
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.Label |
---|
addToken, addTokens, getDefault, getNlsBundle, getNlsKey, getTokens, setDefault, setNlsBundle, setNlsBundleXliff, setNlsKey, setNlsKey |
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.Container |
---|
getMask, setMask |
Method Detail |
---|
void setLinkType(DiagConstants.LinkType pLinkType)
pLinkType
- the link type for the link.void setFunctionName(java.lang.String pFunctionName)
pFunctionName
- the function name for the link.void setLinkURI(java.lang.String pURI)
pURI
- the base URI for the link.void setLinkToMetalinkNote(java.lang.String pNoteId)
pNoteId
- Metalink note ID to which this message
should be linked.void setMsgType(Message.MsgType pMsgType)
pMsgType
- the message type for this message.void addLinkParameter(NameValue pParam)
pParam
- a parameter for the link.void addLinkParameters(NameValueList pParams)
pParams
- a list of parameters for the link.DiagConstants.LinkType getLinkType()
java.lang.String getFunctionName()
java.lang.String getLinkURI()
Message.MsgType getMsgType()
NameValueList getLinkParams()
void addLinkToken(LinkToken pToken)
pToken
- LinkToken to be addedLinkToken
void addLinkTokens(java.util.List<LinkToken> pTokens)
pTokens
- List of LinkTokenLinkToken
java.util.List<LinkToken> getLinkTokens()
LinkToken
|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |