oracle.apps.fnd.appltest.diagfwk.api.report
Interface Message

All Superinterfaces:

Container, DiagConstants, Label, ReportConstants

All Known Subinterfaces:

MessageExtn

All Known Implementing Classes:

MessageExtnImpl

public interface Message
extends Label

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:

1. internal link - In this case the link is to another page within the same Applications System. An internal link will have a function name and a set of parameter name values associated with it.
2. or external link - In this case the link is to a page external to the Applications System (e.g. Metalink). An external link will have a base URL and a set of parameter name values associated with it.

The diagnostic framework, at the time of rendering the report, will use this information to generate the correct URL for the hyperlink on the report.

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.

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/api/report/Message.java /main/9 2008/07/31 18:00:40 syhuda Exp $

Author:

ppradhan

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

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

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

setLinkType

void setLinkType(DiagConstants.LinkType pLinkType)

Sets the link type for the link. The type can be either internal or external.

Parameters:

pLinkType - the link type for the link.

setFunctionName

void setFunctionName(java.lang.String pFunctionName)

Sets the function name for the link. This is required if the link type is internal.

Parameters:

pFunctionName - the function name for the link.

setLinkURI

void setLinkURI(java.lang.String pURI)

Sets the URI for the link. This is required if the link type is external.

Parameters:

pURI - the base URI for the link.

setLinkToMetalinkNote

void setLinkToMetalinkNote(java.lang.String pNoteId)

Sets a link on this message to the given Metalink note ID.

Parameters:

pNoteId - Metalink note ID to which this message should be linked.

setMsgType

void setMsgType(Message.MsgType pMsgType)

Sets the message type for this message

Parameters:

pMsgType - the message type for this message.

addLinkParameter

void addLinkParameter(NameValue pParam)

Adds a parameter for the link.

Parameters:

pParam - a parameter for the link.

addLinkParameters

void addLinkParameters(NameValueList pParams)

Adds a list of parameters for the link.

Parameters:

pParams - a list of parameters for the link.

getLinkType

DiagConstants.LinkType getLinkType()

Gets the link type. The link type can be either internal or external.

Returns:

the link type for the link.

getFunctionName

java.lang.String getFunctionName()

Gets the function name for the link.

Returns:

the function name for the link.

getLinkURI

java.lang.String getLinkURI()

Gets the link URI for the link

Returns:

the link URI for the link

getMsgType

Message.MsgType getMsgType()

Gets the message type for this message

Returns:

the message type for this message.

getLinkParams

NameValueList getLinkParams()

Gets the list of parameters to be added when creating the link URL

Returns:

the list of parameters for the link.

addLinkToken

void addLinkToken(LinkToken pToken)

Adds a Link Token to this Message

Parameters:

pToken - LinkToken to be added

See Also:

LinkToken

addLinkTokens

void addLinkTokens(java.util.List<LinkToken> pTokens)

Adds a list Link Token to this Message

Parameters:

pTokens - List of LinkToken

See Also:

LinkToken

getLinkTokens

java.util.List<LinkToken> getLinkTokens()

Gets the list of Link Tokens

Returns:

List of LinkToken

See Also:

LinkToken