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

All Superinterfaces:

Container, DiagConstants, ReportConstants

All Known Subinterfaces:

StepReportExtn

All Known Implementing Classes:

StepReportExtnImpl

public interface StepReport
extends Container

A container for holding the contents of the report for a step within a test. Each step report can contain a list of Sections and Summary information.

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	addSection(Section pSection) Adds a section to this step's report.
ErrorInfo	getInputError(java.lang.String pInputParamName) Gets the validation error associated with an InputParameter
java.lang.String	getNlsBundle() Gets the NLS Bundle for this report
java.util.List<Section>	getSections() Gets the list of sections in this report
SummaryInfo	getSummary() Gets the summary for this step
void	setInputError(java.lang.String pInputParamName, ErrorInfo pError) Sets validation error for an InputParameter
void	setNlsBundle(java.lang.String pBundleName) Sets the bundle name for the NLS bundle to be used when fetching translatable labels for this report.
void	setNlsBundleXliff(java.lang.String pBundleName) Sets the bundle name for the NLS bundle Xliff to be used when fetching translatable labels for this report.
void	setSummary(SummaryInfo pSummary) Sets the summary to this step's report.

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

getMask, setMask

Method Detail

addSection

void addSection(Section pSection)

Adds a section to this step's report.

Parameters:

pSection - a section to be added to the report.

setSummary

void setSummary(SummaryInfo pSummary)

Sets the summary to this step's report.

Parameters:

pSummary - summary information for this step in the test.

setNlsBundle

void setNlsBundle(java.lang.String pBundleName)

Sets the bundle name for the NLS bundle to be used when fetching translatable labels for this report.

Parameters:

pBundleName - the name of the bundle that is the NLS Java resource bundle.

setNlsBundleXliff

void setNlsBundleXliff(java.lang.String pBundleName)

Sets the bundle name for the NLS bundle Xliff to be used when fetching translatable labels for this report.

Parameters:

pBundleName - the name of the xliff bundle

getSections

java.util.List<Section> getSections()

Gets the list of sections in this report

Returns:

the list of sections in this step report

getSummary

SummaryInfo getSummary()

Gets the summary for this step

Returns:

the summary for this step.

getNlsBundle

java.lang.String getNlsBundle()

Gets the NLS Bundle for this report

Returns:

the NLS bundle for this report

setInputError

void setInputError(java.lang.String pInputParamName,
                   ErrorInfo pError)

Sets validation error for an InputParameter

Parameters:

pInputParamName - name of the InputParameter

pError - validation error associated with pInputParamName

getInputError

ErrorInfo getInputError(java.lang.String pInputParamName)

Gets the validation error associated with an InputParameter

Parameters:

pInputParamName - error associated with this input

Returns:

the validation error if there is an ErrorInfo associated with the input parameter, null otherwise