oracle.apps.fnd.appltest.diagfwk.engine.impl.report
Class TestReportExtnImpl

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.report.ContainerExtnImpl
      oracle.apps.fnd.appltest.diagfwk.engine.impl.report.TestReportExtnImpl

All Implemented Interfaces:

Container, ReportConstants, TestReport, DiagConstants, DiagImplConstants, ContainerExtn, TestReportExtn

public class TestReportExtnImpl
extends ContainerExtnImpl
implements TestReportExtn, DiagImplConstants

Nested Class Summary

static class	TestReportExtnImpl.LinkComputingVisitor A ReportVisitor class that computes the linkURL for each link in the report.
static class	TestReportExtnImpl.TranslatingVisitor A ReportVisitor class that translates each traslatable label or message in the report.

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

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagImplConstants

KEY_I_PARAM_DEF_REF, KEY_O_PARAM_DEF_REF, KEY_REF_TEST_DEF_TABLE, KEY_STEP_INPUT_PARAM_SECRET, SECRET_MASK, STEP_REP_EXEC_NAME_ENGINE, STEP_REP_NAME_ENGINE_LOG, TOKEN_DELIM, TOKEN_OUTPUTS, TOKEN_STEP, TOKEN_TEST_INPUTS, TOKEN_TEST_OUTPUTS

Constructor Summary

TestReportExtnImpl()

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.
void	fillJAXBMetadataObj(TestReport pObj)
java.lang.String	getDateFormat() Returns the date format for the report
java.lang.String	getDateFormatLabel() Returns the date format for the report label
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 label
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 label
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 translattestReported
java.lang.String	getSourceLangLabel() Returns the source language title if the contents of this report has been translattestReported
java.util.Date	getStartDate() Gets the start date
java.lang.String	getStartDateLabel() Gets the start date label
DiagConstants.Status	getStatusCode() Gets the status code for this report
java.lang.String	getStatusCodeLabel() Gets the status code label 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
SummaryInfo	getSummary() Gets the Summary information for this test.
java.lang.String	getTestName() Gets the test name
java.lang.String	getTestNameLabel() Gets the test name label
java.lang.String	getTestTableTitle() Gets the test table title label 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 label 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 format label for this report.
void	setDisplayName(java.lang.String pDisplayName) Sets the display name for the test
void	setEndDate(java.util.Date pEndDate) Sets the end date for this report
void	setEndDateLabel(java.lang.String pEndDateLabel) Sets the end date label 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 Id title 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) mTestReport.
void	setNlsBundle(java.lang.String pNlsBundle) Sets the NLS bundle for the report
void	setNlsBundleLabel(java.lang.String pNlsBundleLabel) Sets the NLS bundle label for the report
void	setRunId(java.lang.String pRunId) Sets the run ID for the run that generated this report
void	setRunIdLabel(java.lang.String pRunIdLabel) Sets the run ID label 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 language code label 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 label for this report
void	setStatusCode(DiagConstants.Status pStatusCode) Sets the status code for this report
void	setStatusCodeLabel(java.lang.String pStatusCodeLabel) Sets the status code label for this report
void	setTestName(java.lang.String pTestName) Sets the name of the test
void	setTestNameLabel(java.lang.String pTestNameLabel) Sets the name label of the test
void	setTestTableTitle(java.lang.String pTestTableTitle) Sets the test 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 label of the test that generated this report
void	translate() Performs a translation of all the translatable labels in this report.
void	visitAll(ReportVisitor pVisitor) Visits all elements within this element and invokes the visitContainer() callback method on the visitor for each child ement visited.

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.report.ContainerExtnImpl

copy, copy, fillJAXBMetadataObj, getMask, getObjectFactory, setJAXBMetadataObj, setMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMask, setMask

Constructor Detail

TestReportExtnImpl

public TestReportExtnImpl()

Method Detail

getTestTableTitle

public java.lang.String getTestTableTitle()

Gets the test table title label currently set in the report

Specified by:

getTestTableTitle in interface TestReportExtn

Returns:

the test table title label current set in the report

getDisplayName

public java.lang.String getDisplayName()

Gets the test display name currently set in the report

Specified by:

getDisplayName in interface TestReportExtn

Returns:

the test display name current set in the report

getSummary

public SummaryInfo getSummary()

Description copied from interface: TestReport

Gets the Summary information for this test.

Specified by:

getSummary in interface TestReport

Returns:

the summary information for this test.

setTestTableTitle

public void setTestTableTitle(java.lang.String pTestTableTitle)

Sets the test table title for the test

Specified by:

setTestTableTitle in interface TestReportExtn

Parameters:

pDisplayName - test table title the display name for the test

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Sets the display name for the test

Specified by:

setDisplayName in interface TestReportExtn

Parameters:

pDisplayName - the display name for the test

setTestNameLabel

public void setTestNameLabel(java.lang.String pTestNameLabel)

Sets the name label of the test

Specified by:

setTestNameLabel in interface TestReportExtn

Parameters:

pTestNameLabel - the name title o f the test

setTestName

public void setTestName(java.lang.String pTestName)

Sets the name of the test

Specified by:

setTestName in interface TestReportExtn

Parameters:

pTestName - the name o f the test

setVersionLabel

public void setVersionLabel(java.lang.String pVersionLabel)

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

Specified by:

setVersionLabel in interface TestReportExtn

Parameters:

pVersionLabel - the version of the test

setVersion

public void setVersion(java.lang.String pVersion)

Sets the version of the test that generated this report

Specified by:

setVersion in interface TestReportExtn

Parameters:

pVersion - the version of the test

setRunIdLabel

public void setRunIdLabel(java.lang.String pRunIdLabel)

Sets the run ID label for the run that generated this report

Specified by:

setRunIdLabel in interface TestReportExtn

Parameters:

pRunId - the run ID label for the run that generated this report

setRunId

public void setRunId(java.lang.String pRunId)

Sets the run ID for the run that generated this report

Specified by:

setRunId in interface TestReportExtn

Parameters:

pRunId - the run ID for the run that generated this report

setStartDateLabel

public void setStartDateLabel(java.lang.String pStartDateLabel)

Sets the start date label for this report

Specified by:

setStartDateLabel in interface TestReportExtn

Parameters:

pStartDate - the start date label for this report

setStartDate

public void setStartDate(java.util.Date pStartDate)

Sets the start date for this report

Specified by:

setStartDate in interface TestReportExtn

Parameters:

pStartDate - the start date for this report

setEndDateLabel

public void setEndDateLabel(java.lang.String pEndDateLabel)

Sets the end date label for this report

Specified by:

setEndDateLabel in interface TestReportExtn

Parameters:

pEndDateLabel - the end date title for this report

setEndDate

public void setEndDate(java.util.Date pEndDate)

Sets the end date for this report

Specified by:

setEndDate in interface TestReportExtn

Parameters:

pEndDate - the end date for this report

setExecutionIdLabel

public void setExecutionIdLabel(java.lang.String pExecutionIdLabel)

Sets the execution Id title for the current exection

Specified by:

setExecutionIdLabel in interface TestReportExtn

Parameters:

pExecutionId - execution ID title for the current execution

setExecutionId

public void setExecutionId(java.lang.String pExecutionId)

Sets the execution Id for the current exection

Specified by:

setExecutionId in interface TestReportExtn

Parameters:

pExecutionId - execution ID for the current execution

setStatusCodeLabel

public void setStatusCodeLabel(java.lang.String pStatusCodeLabel)

Sets the status code label for this report

Specified by:

setStatusCodeLabel in interface TestReportExtn

Parameters:

pStatusCodeLabel - the status code title for this report

setStatusCode

public void setStatusCode(DiagConstants.Status pStatusCode)

Sets the status code for this report

Specified by:

setStatusCode in interface TestReportExtn

Parameters:

pStatusCode - the status code for this report

setNlsBundleLabel

public void setNlsBundleLabel(java.lang.String pNlsBundleLabel)

Sets the NLS bundle label for the report

Specified by:

setNlsBundleLabel in interface TestReportExtn

Parameters:

pNlsBundle - the NLS bundle title for the report

setNlsBundle

public void setNlsBundle(java.lang.String pNlsBundle)

Sets the NLS bundle for the report

Specified by:

setNlsBundle in interface TestReportExtn

Parameters:

pNlsBundle - the NLS bundle for the report

setSourceLangLabel

public void setSourceLangLabel(java.lang.String pSourceLangLabel)

Sets the source language code label for this report

Specified by:

setSourceLangLabel in interface TestReportExtn

Parameters:

pSourceLangLabel - the source language code title for thi mTestReport. mTestReport.s report

setSourceLang

public void setSourceLang(java.lang.String pSourceLang)

Sets the source language code for this report

Specified by:

setSourceLang in interface TestReportExtn

Parameters:

pSourceLang - the source language code for thi mTestReport. mTestReport.s report

setLang

public void setLang(java.lang.String pLang)

mTestReport. Sets the language code for this report

Specified by:

setLang in interface TestReportExtn

Parameters:

pLang - the language code for this report

setDateFormatLabel

public void setDateFormatLabel(java.lang.String pDateFormatLabel)

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

Specified by:

setDateFormatLabel in interface TestReportExtn

Parameters:

pDateFormatLabel - the date format label for this report

setDateFormat

public 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

Specified by:

setDateFormat in interface TestReportExtn

Parameters:

pDateFormat - the date format for this report

addStepReport

public void addStepReport(StepReportExtn pStepReport)

Adds the given StepReport to the test report

Specified by:

addStepReport in interface TestReportExtn

Parameters:

pStepReport - the StepReport to add to this report

getTestNameLabel

public java.lang.String getTestNameLabel()

Gets the test name label

Specified by:

getTestNameLabel in interface TestReportExtn

Returns:

the test name label

getTestName

public java.lang.String getTestName()

Gets the test name

Specified by:

getTestName in interface TestReportExtn

Returns:

the test name

getVersionLabel

public java.lang.String getVersionLabel()

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

Specified by:

getVersionLabel in interface TestReportExtn

Returns:

the version of the test that generated this report

getVersion

public java.lang.String getVersion()

Gets the version of the test that generated this report

Specified by:

getVersion in interface TestReportExtn

Returns:

the version of the test that generated this report

getStartDateLabel

public java.lang.String getStartDateLabel()

Gets the start date label

Specified by:

getStartDateLabel in interface TestReportExtn

Returns:

the start date label

getStartDate

public java.util.Date getStartDate()

Gets the start date

Specified by:

getStartDate in interface TestReportExtn

Returns:

the start date

getEndDateLabel

public java.lang.String getEndDateLabel()

Gets the end date label

Specified by:

getEndDateLabel in interface TestReportExtn

Returns:

the end date label

getEndDate

public java.util.Date getEndDate()

Gets the end date

Specified by:

getEndDate in interface TestReportExtn

Returns:

the end date

getRunIdLabel

public java.lang.String getRunIdLabel()

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

Specified by:

getRunIdLabel in interface TestReportExtn

Returns:

the run ID label for the run that generated this report

getRunId

public java.lang.String getRunId()

Returns the run ID for the run that generated this report

Specified by:

getRunId in interface TestReportExtn

Returns:

the run ID for the run that generated this report

getExecutionIdLabel

public java.lang.String getExecutionIdLabel()

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

Specified by:

getExecutionIdLabel in interface TestReportExtn

Returns:

the execution ID label for the execution that generated this report

getExecutionId

public java.lang.String getExecutionId()

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

Specified by:

getExecutionId in interface TestReportExtn

Returns:

the execution ID for the execution that generated this report

getStatusCodeLabel

public java.lang.String getStatusCodeLabel()

Gets the status code label for this report

Specified by:

getStatusCodeLabel in interface TestReportExtn

Returns:

the status code label for this report

getStatusCode

public DiagConstants.Status getStatusCode()

Gets the status code for this report

Specified by:

getStatusCode in interface TestReportExtn

Returns:

the status code for this report

getNlsBundleLabel

public java.lang.String getNlsBundleLabel()

Returns the NLS Bundle class label

Specified by:

getNlsBundleLabel in interface TestReportExtn

Returns:

the NLS Bundle class label

getNlsBundle

public java.lang.String getNlsBundle()

Returns the NLS Bundle class

Specified by:

getNlsBundle in interface TestReportExtn

Returns:

the NLS Bundle class

getSourceLangLabel

public java.lang.String getSourceLangLabel()

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

Specified by:

getSourceLangLabel in interface TestReportExtn

Returns:

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

getSourceLang

public java.lang.String getSourceLang()

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

Specified by:

getSourceLang in interface TestReportExtn

Returns:

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

getLang

public java.lang.String getLang()

Returns the language code for this report.

Specified by:

getLang in interface TestReportExtn

Returns:

the language code for this report.

getDateFormatLabel

public java.lang.String getDateFormatLabel()

Returns the date format for the report label

Specified by:

getDateFormatLabel in interface TestReportExtn

Returns:

the date format for the report label

getDateFormat

public java.lang.String getDateFormat()

Returns the date format for the report

Specified by:

getDateFormat in interface TestReportExtn

Returns:

the date format for the report

getStepReportList

public java.util.List<StepReportExtn> getStepReportList()

Returns the list of step reports in this report

Specified by:

getStepReportList in interface TestReportExtn

Returns:

the list of step reports

getStepReport

public StepReportExtn getStepReport(java.lang.String pStepName)

Returns the step report for the given step

Specified by:

getStepReport in interface TestReportExtn

Parameters:

pStepName - the step name for which to return the report

Returns:

the step report for the given step

setJAXBMetadataObj

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

Sets the given underlying JAXB TestReport object

Specified by:

setJAXBMetadataObj in interface TestReportExtn

Parameters:

pObj - the underlying JAXB TestReport object for this report

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

getJAXBMetadataObj

public TestReport getJAXBMetadataObj()

Returns the underlying JAXB TestReport object

Specified by:

getJAXBMetadataObj in interface ContainerExtn

Specified by:

getJAXBMetadataObj in interface TestReportExtn

Returns:

the underlying JAXB TestReport object for this report

fillJAXBMetadataObj

public void fillJAXBMetadataObj(TestReport pObj)

computeStatus

public 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 le}ast 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.

Specified by:

computeStatus in interface TestReportExtn

Returns:

a Status object representing the status code for the step.

translate

public void translate()

Description copied from interface: TestReportExtn

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.

Specified by:

translate in interface TestReportExtn

computeLinks

public void computeLinks()

Description copied from interface: TestReportExtn

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.

Specified by:

computeLinks in interface TestReportExtn

visitAll

public void visitAll(ReportVisitor pVisitor)

Description copied from class: ContainerExtnImpl

Visits all elements within this element and invokes the visitContainer() callback method on the visitor for each child ement visited.

Specified by:

visitAll in interface TestReportExtn

Specified by:

visitAll in class ContainerExtnImpl

Parameters:

pVisitor - visitor class to be invoked for each child element visited.

See Also:

ReportVisitor

addErrorInfo

public void addErrorInfo(ErrorInfo pErrorInfo)

Description copied from interface: TestReportExtn

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

Specified by:

addErrorInfo in interface TestReportExtn

Parameters:

pErrorInfo - error information to add to the report

addSection

public 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.

Specified by:

addSection in interface TestReportExtn

Parameters:

pSection - section to add to the report