Oracle Fusion Middleware extensions for Logging and Diagnostics
11g Release 1 (11.1.2)

E22565-02

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

All Superinterfaces:
Container, DiagConstants, ReportConstants
All Known Subinterfaces:
LinkTokenExtn
All Known Implementing Classes:
LinkTokenExtnImpl

public interface LinkToken
extends Container

This class facilitates way to provide an embeded link in a Message. To create a LinkToken please use: ReportElementFactory.createLinkToken(); OR ReportElementFactory.createLinkToken("NOTE1", message); OR ReportElementFactory.createLinkTokenForSupportNote("NOTE1", "1234.1"); Token name is the value that is provided in the message and needs to be replaced by a link. Example Message with a Token: "For a potential solution to the problem, please refer to {LINK1}" In this example "LINK1" is the token name. To repalce "LINK1" in message with a hyperlink create a LinkToken Object and add that to the Message Code: Message myResolutionMsg = ReportElementFactory.createMessage("NLS_KEY_FOR_RESOLUTION_MSG", "Default message"); myResolutionMsg.addLinkToken(ReportElementFactory.createLinkTokenForSupportNote("LINK1", "1234.1")); The message associated with the NLS_KEY_FOR_RESOLUTION_MSG will get displayed as: "For a potential solution to the problem, please refer to 1234.1"


Nested Class Summary
 
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
 Message getMessage()
          Gets the value of the token.
 java.lang.String getName()
          Gets the name of the Token
 void setMessage(Message pValue)
          Sets the value of the token.
 void setName(java.lang.String name)
          Sets the name of the Token.
 
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.Container
getMask, setMask
 

Method Detail

setMessage

void setMessage(Message pValue)
Sets the value of the token. This will contain the hyperlink information.

Parameters:
pValue -

getMessage

Message getMessage()
Gets the value of the token. This will contain the hyperlink information.

Returns:
Message

setName

void setName(java.lang.String name)
Sets the name of the Token. Token name is the value that is provided in the message and needs to be replaced by a link. Example Message with a Token: "For a potential solution to the problem, please refer to {LINK1} In this example "LINK1" is the token name.

Parameters:
name - Name of the Token

getName

java.lang.String getName()
Gets the name of the Token

Returns:
Token name

Oracle Fusion Middleware extensions for Logging and Diagnostics
11g Release 1 (11.1.2)

E22565-02

Copyright © 2011 Oracle. All Rights Reserved.