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

All Superinterfaces:

Container, DiagConstants, ReportConstants, StepReport

All Known Implementing Classes:

StepReportExtnImpl

public interface StepReportExtn
extends StepReport

EXtension interface to the StepReport interface. Provides internal engine APIs for setting additional details on the step report during execution.

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/StepReportExtn.java /main/8 2009/01/06 10:58:24 ppradhan 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) 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	addStepReport(StepReport pStepReport) Adds the given step report to this step report's contents
DiagConstants.Status	computeStatus() Returns the status of this step based on the errors logged in the step report.
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
NameValueList	getInputParameterList() Returns the list of input parameters for this step
StepReportType	getJAXBMetadataObj() Returns the underlying JAXB StepReport object
NameValueList	getOutputParameterList() Returns the list of output parameters for this step
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
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	setJAXBMetadataObj(StepReportType pObj) Sets the given underlying JAXB StepReport object
void	setStartDate(java.util.Date pStartDate) Sets the start date/time for this step
void	setStatusCode(DiagConstants.Status pStautsCode) Sets the status code for this report
void	setStepName(java.lang.String pStepName) Sets the name of the step

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

addSection, getInputError, getNlsBundle, getSections, getSummary, setInputError, setNlsBundle, setNlsBundleXliff, setSummary

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

getMask, setMask

Method Detail

setStepName

void setStepName(java.lang.String pStepName)

Sets the name of the step

Parameters:

pStepName - the name of the step

setExecutableName

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.

Parameters:

pExecutableName - name of the executable for this step.

setExecutableType

void setExecutableType(java.lang.String pExecutableType)

Sets the type of the executable for this step.

Parameters:

pExecutableType - the type of the executable for this step.

setStartDate

void setStartDate(java.util.Date pStartDate)

Sets the start date/time for this step

Parameters:

pStartDate - the start date/time for this step

setEndDate

void setEndDate(java.util.Date pEndDate)

Sets the end date/time for this step

Parameters:

pEndDate - the end date/time for this step

setExecutionId

void setExecutionId(java.lang.String pExecutionId)

Sets the execution ID for this step

Parameters:

pExecutionId - the execution ID for this step.

setStatusCode

void setStatusCode(DiagConstants.Status pStautsCode)

Sets the status code for this report

Parameters:

pStautsCode - the status code for this report

addInputParameter

void addInputParameter(NameValue pParam)

Adds an input parameter for this step

Parameters:

pParam - an input parameter for this step

addInputParameterList

void addInputParameterList(NameValueList pParamList)

Adds the given input parameter list to the step report

Parameters:

pParamList - input parameter list

addOutputParameter

void addOutputParameter(NameValue pParam)

Adds an output parameter for this step

Parameters:

pParam - an output parameter for this step.

addOutputParameterList

void addOutputParameterList(NameValueList pParamList)

Adds the given output parameter list into this step report

Parameters:

pParamList - output parmater list.

getStepName

java.lang.String getStepName()

Returns the step name for this step

Returns:

the step name for this step

getExecutableName

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.

Returns:

the name of the executable for this step.

getExecutableType

java.lang.String getExecutableType()

Returns the type of the executable for this step.

Returns:

the type of the executable for this step.

getStartDate

java.util.Date getStartDate()

Returns the start date for this step

Returns:

the start date for this step

getEndDate

java.util.Date getEndDate()

Returns the end date for this step

Returns:

the end date for this step

getExecutionId

java.lang.String getExecutionId()

Returns the execution id for this step

Returns:

the execution id for this step

getStatusCode

DiagConstants.Status getStatusCode()

Gets the status code for this report

Returns:

the status code for this report

getInputParameterList

NameValueList getInputParameterList()

Returns the list of input parameters for this step

Returns:

the list of input parameters for this step.

getOutputParameterList

NameValueList getOutputParameterList()

Returns the list of output parameters for this step

Returns:

the list of output parameters for this step.

addExecutionError

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

Parameters:

t - Throwable representing the execution error.

addErrorInfo

void addErrorInfo(ErrorInfo pErrorInfo)

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

Parameters:

pErrorInfo - error information to be added to the report.

getJAXBMetadataObj

StepReportType getJAXBMetadataObj()

Returns the underlying JAXB StepReport object

Returns:

the underlying JAXB StepReport object for this report

setJAXBMetadataObj

void setJAXBMetadataObj(StepReportType pObj)

Sets the given underlying JAXB StepReport object

Parameters:

pObj - the underlying JAXB StepReport object for this report

computeStatus

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.

Returns:

a Status object representing the status code for the step.

addStepReport

void addStepReport(StepReport pStepReport)

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

Parameters:

pStepReport - the nested step report to add.

getContents

java.util.List<Container> getContents()

Gets the list of sections and step reports for this report

Returns:

the contents for this step report