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

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

All Implemented Interfaces:

Container, ReportConstants, StepReport, DiagConstants, ContainerExtn, StepReportExtn

public class StepReportExtnImpl
extends ContainerExtnImpl
implements StepReportExtn

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

Constructor Summary

StepReportExtnImpl()

Method Summary

void	addErrorInfo(ErrorInfo pErrorInfo) Convenience method for the engine to report any execution errors into the step report.
void	addExecutionError(java.lang.Throwable t) Convenience method for the engine to report any execution errors into the step report.
void	addInputParameter(NameValue pParam) Adds an input parameter for this step
void	addInputParameterList(NameValueList pParamList) Adds the given input parameter list to the step report
void	addOutputParameter(NameValue pParam) Adds an output parameter for this step
void	addOutputParameterList(NameValueList pParamList) Adds the given output parameter list into this step report
void	addSection(Section pSection) Adds a section to this step's report.
void	addStepReport(StepReport pStepReport) Adds the given step report to this step report's contents
DiagConstants.Status	computeSectionStatus(Section pSection)
DiagConstants.Status	computeStatus() Returns the status of this step based on the errors logged in the step report.
protected static void	copy(StepReportType pSource, StepReportType pTarget)
void	fillJAXBMetadataObj(StepReportType pObj)
java.util.List<Container>	getContents() Gets the list of sections and step reports for this report
java.util.Date	getEndDate() Returns the end date for this step
java.lang.String	getExecutableName() Returns the name of the executable for this step.
java.lang.String	getExecutableType() Returns the type of the executable for this step.
java.lang.String	getExecutionId() Returns the execution id for this step
ErrorInfo	getInputError(java.lang.String pInputParamName) Gets the validation error associated with an input parameter
NameValueList	getInputParameterList() Returns the list of input parameters for this step
StepReportType	getJAXBMetadataObj() Returns the underlying JAXB StepReport object
java.lang.String	getNlsBundle() Gets the NLS Bundle for this report
NameValueList	getOutputParameterList() Returns the list of output parameters for this step
java.util.List<Section>	getSections() Gets the list of sections in this report
java.util.Date	getStartDate() Returns the start date for this step
DiagConstants.Status	getStatusCode() Gets the status code for this report
java.lang.String	getStepName() Returns the step name for this step
SummaryInfo	getSummary() Gets the summary for this step
void	setEndDate(java.util.Date pEndDate) Sets the end date/time for this step
void	setExecutableName(java.lang.String pExecutableName) Sets the name of the executable for this step.
void	setExecutableType(java.lang.String pExecutableType) Sets the type of the executable for this step.
void	setExecutionId(java.lang.String pExecutionId) Sets the execution ID for this step
void	setInputError(java.lang.String pInputParamName, ErrorInfo pError) Sets validation error associated with an input parameter
void	setJAXBMetadataObj(StepReportType pObj) Sets the given underlying JAXB StepReport object
void	setNlsBundle(java.lang.String pNlsBundle) Sets the bundle name for the NLS bundle to be used when fetching translatable labels for this report.
void	setNlsBundleXliff(java.lang.String pNlsBundle) Sets the bundle name for the NLS bundle Xliff to be used when fetching translatable labels for this report.
void	setStartDate(java.util.Date pStartDate) Sets the start date/time for this step
void	setStatusCode(DiagConstants.Status pStatusCode) Sets the status code for this report
void	setStepName(java.lang.String pStepName) Sets the name of the step
void	setSummary(SummaryInfo pSummary) Sets the summary to this step's 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

StepReportExtnImpl

public StepReportExtnImpl()

Method Detail

setStepName

public void setStepName(java.lang.String pStepName)

Sets the name of the step

Specified by:

setStepName in interface StepReportExtn

Parameters:

pStepName - the name of the step

setExecutableName

public void setExecutableName(java.lang.String pExecutableName)

Sets the name of the executable for this step. This is generally a Java class name for java steps or test name for test reference steps.

Specified by:

setExecutableName in interface StepReportExtn

Parameters:

pExecutableName - name of the executable for this step.

setExecutableType

public void setExecutableType(java.lang.String pExecutableType)

Sets the type of the executable for this step.

Specified by:

setExecutableType in interface StepReportExtn

Parameters:

pExecutableType - the type of the executable for this step.

setStartDate

public void setStartDate(java.util.Date pStartDate)

Sets the start date/time for this step

Specified by:

setStartDate in interface StepReportExtn

Parameters:

pStartDate - the start date/time for this step

setEndDate

public void setEndDate(java.util.Date pEndDate)

Sets the end date/time for this step

Specified by:

setEndDate in interface StepReportExtn

Parameters:

pEndDate - the end date/time for this step

setExecutionId

public void setExecutionId(java.lang.String pExecutionId)

Sets the execution ID for this step

Specified by:

setExecutionId in interface StepReportExtn

Parameters:

pExecutionId - the execution ID for this step.

setStatusCode

public void setStatusCode(DiagConstants.Status pStatusCode)

Sets the status code for this report

Specified by:

setStatusCode in interface StepReportExtn

Parameters:

pStatusCode - the status code for this report

addSection

public void addSection(Section pSection)

Adds a section to this step's report.

Specified by:

addSection in interface StepReport

Parameters:

pSection - a section to be added to the report.

addStepReport

public void addStepReport(StepReport pStepReport)

Description copied from interface: StepReportExtn

Adds the given step report to this step report's contents

Specified by:

addStepReport in interface StepReportExtn

Parameters:

pStepReport - the nested step report to add.

setSummary

public void setSummary(SummaryInfo pSummary)

Sets the summary to this step's report.

Specified by:

setSummary in interface StepReport

Parameters:

pSummary - summary information for this step in the test.

setNlsBundle

public void setNlsBundle(java.lang.String pNlsBundle)

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

Specified by:

setNlsBundle in interface StepReport

Parameters:

pNlsBundle - the name of the bundle that is the NLS resource bundle.

setNlsBundleXliff

public void setNlsBundleXliff(java.lang.String pNlsBundle)

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

Specified by:

setNlsBundleXliff in interface StepReport

Parameters:

pNlsBundle -

getSections

public java.util.List<Section> getSections()

Gets the list of sections in this report

Specified by:

getSections in interface StepReport

Returns:

the list of sections in this step report

getContents

public java.util.List<Container> getContents()

Gets the list of sections and step reports for this report

Specified by:

getContents in interface StepReportExtn

Returns:

the contents for this step report

getSummary

public SummaryInfo getSummary()

Gets the summary for this step

Specified by:

getSummary in interface StepReport

Returns:

the summary for this step.

getNlsBundle

public java.lang.String getNlsBundle()

Gets the NLS Bundle for this report

Specified by:

getNlsBundle in interface StepReport

Returns:

the NLS bundle for this report

addInputParameter

public void addInputParameter(NameValue pParam)

Description copied from interface: StepReportExtn

Adds an input parameter for this step

Specified by:

addInputParameter in interface StepReportExtn

Parameters:

pParam - an input parameter for this step

addInputParameterList

public void addInputParameterList(NameValueList pParamList)

Description copied from interface: StepReportExtn

Adds the given input parameter list to the step report

Specified by:

addInputParameterList in interface StepReportExtn

Parameters:

pParamList - input parameter list

addOutputParameter

public void addOutputParameter(NameValue pParam)

Adds an output parameter for this step

Specified by:

addOutputParameter in interface StepReportExtn

Parameters:

pParam - an output parameter for this step.

addOutputParameterList

public void addOutputParameterList(NameValueList pParamList)

Adds the given output parameter list into this step report

Specified by:

addOutputParameterList in interface StepReportExtn

Parameters:

pParamList - output parmater list.

addExecutionError

public void addExecutionError(java.lang.Throwable t)

Convenience method for the engine to report any execution errors into the step report. Construct an ErrorInfo based on the information in the given Throwable (message,trace) and appends it to the last section in the report. If there are no sections, creates a default "Execution Errors" section and adds it under that section

Specified by:

addExecutionError in interface StepReportExtn

Parameters:

t - Throwable representing the execution error.

addErrorInfo

public void addErrorInfo(ErrorInfo pErrorInfo)

Description copied from interface: StepReportExtn

Convenience method for the engine to report any execution errors into the step report. Appends the given ErrorInfo to the last section in the report. If there are no sections, creates a default "Execution Errors" section and adds it under that section

Specified by:

addErrorInfo in interface StepReportExtn

Parameters:

pErrorInfo - error information to be added to the report.

getStepName

public java.lang.String getStepName()

Returns the step name for this step

Specified by:

getStepName in interface StepReportExtn

Returns:

the step name for this step

getExecutableName

public java.lang.String getExecutableName()

Returns the name of the executable for this step. This is generally a Java class name for java steps or test name for test reference steps.

Specified by:

getExecutableName in interface StepReportExtn

Returns:

the name of the executable for this step.

getExecutableType

public java.lang.String getExecutableType()

Returns the type of the executable for this step.

Specified by:

getExecutableType in interface StepReportExtn

Returns:

the type of the executable for this step.

getStartDate

public java.util.Date getStartDate()

Returns the start date for this step

Specified by:

getStartDate in interface StepReportExtn

Returns:

the start date for this step

getEndDate

public java.util.Date getEndDate()

Returns the end date for this step

Specified by:

getEndDate in interface StepReportExtn

Returns:

the end date for this step

getExecutionId

public java.lang.String getExecutionId()

Returns the execution id for this step

Specified by:

getExecutionId in interface StepReportExtn

Returns:

the execution id for this step

getStatusCode

public DiagConstants.Status getStatusCode()

Gets the status code for this report

Specified by:

getStatusCode in interface StepReportExtn

Returns:

the status code for this report

getInputParameterList

public NameValueList getInputParameterList()

Returns the list of input parameters for this step

Specified by:

getInputParameterList in interface StepReportExtn

Returns:

the list of input parameters for this step.

getOutputParameterList

public NameValueList getOutputParameterList()

Returns the list of output parameters for this step

Specified by:

getOutputParameterList in interface StepReportExtn

Returns:

the list of output parameters for this step.

getJAXBMetadataObj

public StepReportType getJAXBMetadataObj()

Returns the underlying JAXB StepReport object

Specified by:

getJAXBMetadataObj in interface ContainerExtn

Specified by:

getJAXBMetadataObj in interface StepReportExtn

Returns:

the underlying JAXB StepReport object for this report

fillJAXBMetadataObj

public void fillJAXBMetadataObj(StepReportType pObj)

copy

protected static void copy(StepReportType pSource,
                           StepReportType pTarget)

setJAXBMetadataObj

public void setJAXBMetadataObj(StepReportType pObj)

Sets the given underlying JAXB StepReport object

Specified by:

setJAXBMetadataObj in interface StepReportExtn

Parameters:

pObj - the underlying JAXB StepReport object for this report

computeStatus

public DiagConstants.Status computeStatus()

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

• If the statusCode attribute is set for this step report, returns the status code. Otherwise computes the status ...
• Returns Status.EXECERROR if at least one ErrorInfo with error type "E" (execution error) exists in the report.
• Returns Status.FAILURE if at least one ErrorInfo with error type "D" (diagnostic error) and severity "C" (critical) exists in the report.
• Returns Status.WARNING if at least one ErrorInfo with error type "D" (diagnostic error) and severity "W" (warning) exists in the report.
• Returns Status.SUCCESS if no ErrorInfo is logged in the report.

Specified by:

computeStatus in interface StepReportExtn

Returns:

a Status object representing the status code for the step.

computeSectionStatus

public DiagConstants.Status computeSectionStatus(Section pSection)

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 class ContainerExtnImpl

Parameters:

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

setInputError

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

Sets validation error associated with an input parameter

Specified by:

setInputError in interface StepReport

Parameters:

pInputParamName, - the input parameter

pError, - the validaton error

getInputError

public ErrorInfo getInputError(java.lang.String pInputParamName)

Gets the validation error associated with an input parameter

Specified by:

getInputError in interface StepReport

Parameters:

pInputParamName, - the parameter name

Returns:

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