oracle.apps.fnd.appltest.diagfwk.engine.impl.report
Interface TestReportExtn

All Superinterfaces:

Container, DiagConstants, ReportConstants, TestReport

All Known Implementing Classes:

TestReportExtnImpl

public interface TestReportExtn
extends TestReport

Extension interface to the public TestReport interface. Provides additional APIs that the engine uses internally during execution to set internal attributes and contents into the report.

Since:

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

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/impl/report/TestReportExtn.java /main/13 2010/04/05 17:21:27 cshare Exp $

Author:

ppradhan

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	addErrorInfo(ErrorInfo pErrorInfo) Adds the given error to the end of this report i.e.
void	addSection(Section pSection) Adds the given section to the end of this report i.e.
void	addStepReport(StepReportExtn pStepReport) Adds the given StepReport to the test report
void	computeLinks() Computes the link URL specified for each Message (if any) within this report.
DiagConstants.Status	computeStatus() Returns the status of this test based on the errors logged in the step report.
java.lang.String	getDateFormat() Returns the date format for the report
java.lang.String	getDateFormatLabel() Returns the date format title for the report
java.lang.String	getDisplayName() Gets the test display name currently set in the report
java.util.Date	getEndDate() Gets the end date
java.lang.String	getEndDateLabel() Gets the end date title
java.lang.String	getExecutionId() Returns the execution ID for the execution that generated this report.
java.lang.String	getExecutionIdLabel() Returns the execution ID Label for the execution that generated this report.
TestReport	getJAXBMetadataObj() Returns the underlying JAXB TestReport object
java.lang.String	getLang() Returns the language code for this report.
java.lang.String	getNlsBundle() Returns the NLS Bundle class
java.lang.String	getNlsBundleLabel() Returns the NLS Bundle class title
java.lang.String	getRunId() Returns the run ID for the run that generated this report
java.lang.String	getRunIdLabel() Returns the run ID Label for the run that generated this report
java.lang.String	getSourceLang() Returns the source language if the contents of this report has been translated
java.lang.String	getSourceLangLabel() Returns the source language title if the contents of this report has been translated
java.util.Date	getStartDate() Gets the start date
java.lang.String	getStartDateLabel() Gets the start dateLabel
DiagConstants.Status	getStatusCode() Gets the status code for this report
java.lang.String	getStatusCodeLabel() Gets the status code title for this report
StepReportExtn	getStepReport(java.lang.String pStepName) Returns the step report for the given step
java.util.List<StepReportExtn>	getStepReportList() Returns the list of step reports in this report
java.lang.String	getTestName() Gets the test name
java.lang.String	getTestNameLabel() Gets the test nameLabel
java.lang.String	getTestTableTitle() Gets the test table title currently set in the report
java.lang.String	getVersion() Gets the version of the test that generated this report
java.lang.String	getVersionLabel() Gets the version report title of the test that generated this report
void	setDateFormat(java.lang.String pDateFormat) Sets the date format for this report.
void	setDateFormatLabel(java.lang.String pDateFormatLabel) Sets the date formatLabel for this report.
void	setDisplayName(java.lang.String pDisplayName) Sets the version report title of the test that generated this report
void	setEndDate(java.util.Date pEndDate) Sets the end date for this report
void	setEndDateLabel(java.lang.String pEndDateLabel) Sets the end dateLabel for this report
void	setExecutionId(java.lang.String pExecutionId) Sets the execution Id for the current exection
void	setExecutionIdLabel(java.lang.String pExecutionIdLabel) Sets the execution IdLabel for the current exection
void	setJAXBMetadataObj(TestReport pObj, java.lang.Boolean pViewReportAllowed) Sets the given underlying JAXB TestReport object
void	setLang(java.lang.String pLang) Sets the language code for this report
void	setNlsBundle(java.lang.String pNlsBundle) Sets the NLS bundle for the report
void	setNlsBundleLabel(java.lang.String pNlsBundleLabel) Sets the NLS bundleLabel for the report
void	setRunId(java.lang.String pRunId) Sets the run IDfor the run that generated this report
void	setRunIdLabel(java.lang.String pRunIdLabel) Sets the run IDLabel for the run that generated this report
void	setSourceLang(java.lang.String pSourceLang) Sets the source language code for this report
void	setSourceLangLabel(java.lang.String pSourceLangLabel) Sets the source languageLabel code for this report
void	setStartDate(java.util.Date pStartDate) Sets the start date for this report
void	setStartDateLabel(java.lang.String pStartDateLabel) Sets the start date title for this report
void	setStatusCode(DiagConstants.Status pStatusCode) Sets the status code for this report
void	setStatusCodeLabel(java.lang.String pStatusCodeLabel) Sets the status codeLabel for this report
void	setTestName(java.lang.String pTestName) Sets the title name for the test
void	setTestNameLabel(java.lang.String pTestNameLabel) Sets the header title of the test
void	setTestTableTitle(java.lang.String pTestTableTitle) Sets the table title for the test
void	setVersion(java.lang.String pVersion) Sets the version of the test that generated this report
void	setVersionLabel(java.lang.String pVersionLabel) Sets the version report title of the test that generated this report
void	translate() Performs a translation of all the translatable labels in this report.
void	visitAll(ReportVisitor visitor) Traverses each element in this test report and invokes the callback APIs on the given visitor class during the traversal.

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

getSummary

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

getMask, setMask

Method Detail

setTestNameLabel

void setTestNameLabel(java.lang.String pTestNameLabel)

Sets the header title of the test

Parameters:

pTestNameLabel - the name of the test header title

setTestName

void setTestName(java.lang.String pTestName)

Sets the title name for the test

Parameters:

pDisplayName - the display name for the test header title

setTestTableTitle

void setTestTableTitle(java.lang.String pTestTableTitle)

Sets the table title for the test

Parameters:

pDTestTableTitle - the table title for the test

setDisplayName

void setDisplayName(java.lang.String pDisplayName)

Sets the version report title of the test that generated this report

Parameters:

pVersionLabel - the version of the test

setVersionLabel

void setVersionLabel(java.lang.String pVersionLabel)

Sets the version report title of the test that generated this report

Parameters:

pVersionLabel - the version of the test

setVersion

void setVersion(java.lang.String pVersion)

Sets the version of the test that generated this report

Parameters:

pVersion - the version of the test

setRunIdLabel

void setRunIdLabel(java.lang.String pRunIdLabel)

Sets the run IDLabel for the run that generated this report

Parameters:

pRunIdLabel - the run IDLabel for the run that generated this report

setRunId

void setRunId(java.lang.String pRunId)

Sets the run IDfor the run that generated this report

Parameters:

pRunIdthe - run IDfor the run that generated this report

setStartDateLabel

void setStartDateLabel(java.lang.String pStartDateLabel)

Sets the start date title for this report

Parameters:

pStartDateLabel - title the start date for this report

setStartDate

void setStartDate(java.util.Date pStartDate)

Sets the start date for this report

Parameters:

pStartDate - the start date for this report

setEndDateLabel

void setEndDateLabel(java.lang.String pEndDateLabel)

Sets the end dateLabel for this report

Parameters:

pEndDateLabel - the end dateLabel for this report

setEndDate

void setEndDate(java.util.Date pEndDate)

Sets the end date for this report

Parameters:

pEndDate - the end date for this report

setExecutionIdLabel

void setExecutionIdLabel(java.lang.String pExecutionIdLabel)

Sets the execution IdLabel for the current exection

Parameters:

pExecutionIdLabel - execution IDLabel for the current execution

setExecutionId

void setExecutionId(java.lang.String pExecutionId)

Sets the execution Id for the current exection

Parameters:

pExecutionId - execution ID for the current execution

setStatusCodeLabel

void setStatusCodeLabel(java.lang.String pStatusCodeLabel)

Sets the status codeLabel for this report

Parameters:

pStatusCodeLabel - the status codeLabel for this report

setStatusCode

void setStatusCode(DiagConstants.Status pStatusCode)

Sets the status code for this report

Parameters:

pStatusCode - the status code for this report

setNlsBundleLabel

void setNlsBundleLabel(java.lang.String pNlsBundleLabel)

Sets the NLS bundleLabel for the report

Parameters:

pNlsBundleLabel - the NLS bundleLabel for the report

setNlsBundle

void setNlsBundle(java.lang.String pNlsBundle)

Sets the NLS bundle for the report

Parameters:

pNlsBundle - the NLS bundle for the report

setSourceLangLabel

void setSourceLangLabel(java.lang.String pSourceLangLabel)

Sets the source languageLabel code for this report

Parameters:

pSourceLangLabel - the source language codeLabel for this report

setSourceLang

void setSourceLang(java.lang.String pSourceLang)

Sets the source language code for this report

Parameters:

pSourceLang - the source language code for this report

setLang

void setLang(java.lang.String pLang)

Sets the language code for this report

Parameters:

pLang - the language code for this report

setDateFormatLabel

void setDateFormatLabel(java.lang.String pDateFormatLabel)

Sets the date formatLabel for this report. This date format indicates the format in which all the date attributes in this report are serialized in the XML document

Parameters:

pDateFormatLabel - the date formatLabel for this report

setDateFormat

void setDateFormat(java.lang.String pDateFormat)

Sets the date format for this report. This date format indicates the format in which all the date attributes in this report are serialized in the XML document

Parameters:

pDateFormat - the date format for this report

addStepReport

void addStepReport(StepReportExtn pStepReport)

Adds the given StepReport to the test report

Parameters:

pStepReport - the StepReport to add to this report

getTestNameLabel

java.lang.String getTestNameLabel()

Gets the test nameLabel

Returns:

the test nameLabel

getTestName

java.lang.String getTestName()

Gets the test name

Returns:

the test name

getTestTableTitle

java.lang.String getTestTableTitle()

Gets the test table title currently set in the report

Returns:

the test table title current set in the report

getDisplayName

java.lang.String getDisplayName()

Gets the test display name currently set in the report

Returns:

the test display name current set in the report

getVersionLabel

java.lang.String getVersionLabel()

Gets the version report title of the test that generated this report

Returns:

the versionLabel of the test that generated this report

getVersion

java.lang.String getVersion()

Gets the version of the test that generated this report

Returns:

the version title of the test that generated this report

getStartDateLabel

java.lang.String getStartDateLabel()

Gets the start dateLabel

Returns:

the start dateLabel

getStartDate

java.util.Date getStartDate()

Gets the start date

Returns:

the start date

getEndDateLabel

java.lang.String getEndDateLabel()

Gets the end date title

Returns:

the end date title

getEndDate

java.util.Date getEndDate()

Gets the end date

Returns:

the end date

getRunIdLabel

java.lang.String getRunIdLabel()

Returns the run ID Label for the run that generated this report

Returns:

the run ID Label for the run that generated this report

getRunId

java.lang.String getRunId()

Returns the run ID for the run that generated this report

Returns:

the run ID for the run that generated this report

getExecutionIdLabel

java.lang.String getExecutionIdLabel()

Returns the execution ID Label for the execution that generated this report.

Returns:

the execution ID Label for the execution that generated this report

getExecutionId

java.lang.String getExecutionId()

Returns the execution ID for the execution that generated this report.

Returns:

the execution ID for the execution that generated this report

getStatusCodeLabel

java.lang.String getStatusCodeLabel()

Gets the status code title for this report

Returns:

the status code title for this report

getStatusCode

DiagConstants.Status getStatusCode()

Gets the status code for this report

Returns:

the status code for this report

getNlsBundleLabel

java.lang.String getNlsBundleLabel()

Returns the NLS Bundle class title

Returns:

the NLS Bundle class title

getNlsBundle

java.lang.String getNlsBundle()

Returns the NLS Bundle class

Returns:

the NLS Bundle class

getSourceLangLabel

java.lang.String getSourceLangLabel()

Returns the source language title if the contents of this report has been translated

Returns:

the source languagetitle if the contents of this report has been translated

getSourceLang

java.lang.String getSourceLang()

Returns the source language if the contents of this report has been translated

Returns:

the source language if the contents of this report has been translated

getLang

java.lang.String getLang()

Returns the language code for this report.

Returns:

the language code for this report.

getDateFormatLabel

java.lang.String getDateFormatLabel()

Returns the date format title for the report

Returns:

the date format title for the report

getDateFormat

java.lang.String getDateFormat()

Returns the date format for the report

Returns:

the date format for the report

getStepReportList

java.util.List<StepReportExtn> getStepReportList()

Returns the list of step reports in this report

Returns:

the list of step reports

getStepReport

StepReportExtn getStepReport(java.lang.String pStepName)

Returns the step report for the given step

Parameters:

pStepName - the step name for which to return the report

Returns:

the step report for the given step

getJAXBMetadataObj

TestReport getJAXBMetadataObj()

Returns the underlying JAXB TestReport object

Returns:

the underlying JAXB TestReport object for this report

setJAXBMetadataObj

void setJAXBMetadataObj(TestReport pObj,
                        java.lang.Boolean pViewReportAllowed)

Sets the given underlying JAXB TestReport object

Parameters:

pObj - the underlying JAXB TestReport object for this report

pViewReportAllowed - Boolean representing whether the user is allowed to view the full report

computeStatus

DiagConstants.Status computeStatus()

Returns the status of this test based on the errors logged in the step report. The status is determined as follows:

• If the statusCode is set for this report, returns it. Otherwise..
• Returns Status.EXECERROR if at least one Step in the test completed with execution error
• Returns Status.FAILURE if at least one Step in the test completed with a failure (i.e. a diagnostic error of critical severity)
• Returns Status.WARNING if at least one Step in the test completed with a diagnostic error of warning severity
• Returns Status.SUCCESS if all Steps completed succesfully.

Returns:

a Status object representing the status code for the step.

translate

void translate()

Performs a translation of all the translatable labels in this report. The translated labels are set into the "default" attributes of the particular label elements. Current user's preferred language (from his session settings) is used to determine the language for translation.

computeLinks

void computeLinks()

Computes the link URL specified for each Message (if any) within this report. Such computed link URLs are then set into the linkURI attribute of the same Message.

visitAll

void visitAll(ReportVisitor visitor)

Traverses each element in this test report and invokes the callback APIs on the given visitor class during the traversal.

Refer to the ReportVisitor for additional details on the visitor traversal of the report elements.

Parameters:

visitor - instance of Visitor class implementation to be used during the traversal.

See Also:

ReportVisitor

addErrorInfo

void addErrorInfo(ErrorInfo pErrorInfo)

Adds the given error to the end of this report i.e. to the end of the last section in the last step report in this report. If a step report and/or a section do not already exist a default step report and/or section are created in the report.

This API is generally intended for the engine to call in order to log unexpected errors during test execution

Parameters:

pErrorInfo - error information to add to the report

addSection

void addSection(Section pSection)

Adds the given section to the end of this report i.e. to the end of the last step report in this report. If a step report does not already exist a default step report is created in the report.

Parameters:

pSection - section to add to the report