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

All Superinterfaces:

Container, DiagConstants, ReportConstants

All Known Subinterfaces:

DescriptiveHeader, DescriptiveHeaderExtn, Header, HeaderExtn, LabelExtn, Message, MessageExtn

All Known Implementing Classes:

DescriptiveHeaderExtnImpl, HeaderExtnImpl, LabelExtnImpl, MessageExtnImpl

public interface Label
extends Container

Represent a translatable piece of text to be added to the diagnostic test report.

The label can have a NLS key that represents the name of the message along with one or more token name value pairs that are to be substituted when translating the message.

Additionally, the label can also have a default text to be used whenever the data for the label is not translatable.

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

void	addToken(NameValue pToken) Adds the given token to the list of tokens to be used when translating the text for this label.
void	addTokens(java.util.List<NameValue> pTokens) Adds the given list of tokens to the list of tokens to be used when translating the text for this label.
java.lang.String	getDefault() Gets the default text for this label.
java.lang.String	getNlsBundle() Gets the NLS bundle for this label.
java.lang.String	getNlsKey() Gets the NLS key for this label.
NameValueList	getTokens() Gets the list of tokens for this label.
void	setDefault(java.lang.String pDefault) Sets the default text for this label
void	setNlsBundle(java.lang.String pNlsBundle) Sets the NLS bundle for this label.
void	setNlsBundleXliff(java.lang.String pNlsBundle) Sets the NLS bundle Xliff for this label.
void	setNlsKey(java.lang.String pNlsKey) Sets the NLS key for this label.
void	setNlsKey(java.lang.String pAppCode, java.lang.String pMsgName) Sets the NLS key using the given App code and message name.

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.report.Container

getMask, setMask

Method Detail

setNlsKey

void setNlsKey(java.lang.String pNlsKey)

Sets the NLS key for this label.

Parameters:

pNlsKey - the NLS key for this label.

setNlsKey

void setNlsKey(java.lang.String pAppCode,
               java.lang.String pMsgName)

Sets the NLS key using the given App code and message name. The resulting NLS key is for the format [appcode]:::[messagename] This API is intended for clients who are using the FND Message Service as the NLS Bundle for their test reports.

Parameters:

pAppCode - Application short name

pMsgName - Name of the message

setNlsBundle

void setNlsBundle(java.lang.String pNlsBundle)

Sets the NLS bundle for this label.

Parameters:

pNlsBundle - the NLS bundle for this label

setNlsBundleXliff

void setNlsBundleXliff(java.lang.String pNlsBundle)

Sets the NLS bundle Xliff for this label.

Parameters:

pNlsBundle - the NLS bundle for this label

setDefault

void setDefault(java.lang.String pDefault)

Sets the default text for this label

Parameters:

pDefault - the default text for this label.

addToken

void addToken(NameValue pToken)

Adds the given token to the list of tokens to be used when translating the text for this label.

Parameters:

pToken - token to be added to the list of tokens to be used when translating the text for this label.

addTokens

void addTokens(java.util.List<NameValue> pTokens)

Adds the given list of tokens to the list of tokens to be used when translating the text for this label.

Parameters:

pTokens - the list of tokens to be added to the list of tokens to be used when translating the text for this label.

getNlsKey

java.lang.String getNlsKey()

Gets the NLS key for this label.

Returns:

the NLS key for this label

getNlsBundle

java.lang.String getNlsBundle()

Gets the NLS bundle for this label.

Returns:

the NLS bundle for this label.

getDefault

java.lang.String getDefault()

Gets the default text for this label.

Returns:

the default text for this label.

getTokens

NameValueList getTokens()

Gets the list of tokens for this label.

Returns:

the list of tokens for this label.