oracle.apps.fnd.appltest.diagfwk.engine
Interface TestExec

All Superinterfaces:

DiagBObj<TestExec>, DiagConstants, DiagTreeNode, TestMoniterable<TestExec>, TestRunTreeNode

All Known Implementing Classes:

TestExecImpl

public interface TestExec
extends TestMoniterable<TestExec>, TestRunTreeNode

Models a single test execution

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.facade.TestRunTreeNode

TestRunTreeNode.NodeType

Field Summary

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	addChild(TestExec pChild) Adds the given TestExec object to the list of this execution's child executions.
void	completeStepReport(java.lang.String pStepName) Complets the step report for the given step
void	computeLinksInReport() Computes the links within the contents of this report as well as any nested reports.
void	copy(TestExec e) Copies contents of the given TestExec object into this object
void	fetch() Fetches the details of a particular test execution.
void	fetch(boolean pFetchChildExecutions) Fetches the details of a particular test execution.
void	fetch(boolean pFetchChildExecutions, boolean bLoadReport) Fetches the details of a particular test execution.
TestExecList	getChildTestExecList() Gets the list of child executions for this test if any
java.util.Date	getEndTime() Gets the end time
java.lang.String	getExecutionId() Gets the test execution id
java.lang.String	getParentExecutionId() Gets the parent execution id if any
java.lang.String	getReport() Gets the execution report in the form a XML document
TestReportExtn	getReportObj() Returns the associated report object
java.lang.String	getRunId() Gets the test run id
java.util.Date	getStartTime() Gets the start time
java.lang.String	getTestDisplayName() Gets the test display name for this execution
java.lang.String	getTestId() Gets the test id
java.lang.String	getTestName() Gets the test name for this execution
java.lang.Boolean	getViewReportAllowed()
void	initializeReport(java.lang.String pTestName, java.lang.String pTestDisplayName, java.lang.String pTestVersion) Initializes the test report
void	initializeStepReport(java.lang.String pStepName, java.lang.String pExecName, java.lang.String pExecType) Initializes the step report for the given step name
void	setChildTestExecList(TestExecList childExecList) Sets the list of child executions for this test if any
void	setEndTime(java.util.Date pEndTime) Sets the end time
void	setExecutionId(java.lang.String pExecutionId) Sets the execution id
void	setParentExecutionId(java.lang.String pParentExecutionId) Sets the parent execution id
void	setReport(java.lang.String pReport) Sets the report XML
void	setReportObj(TestReportExtn pReport) Sets the associated report object
void	setRunId(java.lang.String pRunId) Sets the run id
void	setStartTime(java.util.Date pStartTime) Sets the start time
void	setStatus(java.lang.String pStatus) Sets the status
void	setTestDisplayName(java.lang.String testDisplayName) Sets the test display name for this execution
void	setTestId(java.lang.String pTestId) Sets the test id
void	setTestName(java.lang.String pTestName) Sets the test name for this execution
void	setViewReportAllowed(java.lang.Boolean pViewReportAllowed)
void	translateReport() Translates the translatable contents of this report to user's session language.
void	visitAll(TestRun.TestRunVisitor pVisitor) Traverses this Execution as well as all Exections under this Execution and invokes the appropriate "visit()" method on the TestRunVisitor for each node.
java.lang.String	writeReport(java.lang.String pOutDir, boolean pWriteChildExecutions, DiagConstants.Format pFormat) Writes the contents of this execution's report in the specified format to the given output directory.
java.lang.String	writeReport(java.lang.String pOutDir, DiagConstants.Format pFormat) Writes the contents of this execution's report in the specified format to the given output directory.
java.lang.String	writeReportHTML(java.lang.String pOutDir) Writes the contents of this execution's report in HTML format to the given output directory.
java.lang.String	writeReportHTML(java.lang.String pOutDir, boolean pWriteChildExecutions) Writes the contents of this execution's report in HTML format to the given output directory.
java.lang.String	writeReportXML(java.lang.String pOutDir) Writes the report for this execution as well as all included executions (if any) to the given output directory.
java.lang.String	writeReportXML(java.lang.String pOutDir, boolean pWriteChildExecutions) Writes the report for this execution to the given output directory.

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.TestMoniterable

checkCanceled, checkDone, getStatus, isDone, save

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagBObj

copyT, getCreatedBy, getCreationDate, getLastUpdateDate, getLastUpdatedBy, getLastUpdateLogin, isCreatedByOracle, setCreatedBy, setCreationDate, setLastUpdateDate, setLastUpdatedBy, setLastUpdateLogin

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.facade.TestRunTreeNode

getChildren, getCreatedBy, getDiagStatus, getDisplayName, getElapsedTime, getExecStatus, getID, getName, getNodeReportObj, getNodeType, getRunBy, getStatus, hasReport, isDone

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.facade.DiagTreeNode

hasChildren

Method Detail

getExecutionId

java.lang.String getExecutionId()

Gets the test execution id

Returns:

the test execution id

getRunId

java.lang.String getRunId()

Gets the test run id

Returns:

the test run id

getTestId

java.lang.String getTestId()

Gets the test id

Returns:

the test id

getTestName

java.lang.String getTestName()

Gets the test name for this execution

Returns:

the test name for this execution

getTestDisplayName

java.lang.String getTestDisplayName()

Gets the test display name for this execution

Returns:

display name for the test executed in this execution.

getParentExecutionId

java.lang.String getParentExecutionId()

Gets the parent execution id if any

Returns:

the parent execution id if any

getStartTime

java.util.Date getStartTime()

Gets the start time

Specified by:

getStartTime in interface TestRunTreeNode

Returns:

the start time

getEndTime

java.util.Date getEndTime()

Gets the end time

Specified by:

getEndTime in interface TestRunTreeNode

Returns:

the end time

getReport

java.lang.String getReport()

Gets the execution report in the form a XML document

Returns:

the execution report

getReportObj

TestReportExtn getReportObj()

Returns the associated report object

Returns:

the execution report object

setReportObj

void setReportObj(TestReportExtn pReport)

Sets the associated report object

Parameters:

pReport - the execution report object

getChildTestExecList

TestExecList getChildTestExecList()

Gets the list of child executions for this test if any

Returns:

the list of child executions for this test if any

setExecutionId

void setExecutionId(java.lang.String pExecutionId)

Sets the execution id

Parameters:

pExecutionId - the execution id

setRunId

void setRunId(java.lang.String pRunId)

Sets the run id

Parameters:

pRunId - the run id

setTestId

void setTestId(java.lang.String pTestId)

Sets the test id

Parameters:

pTestId - the test id

setTestName

void setTestName(java.lang.String pTestName)

Sets the test name for this execution

Parameters:

pTestName - the test name for this execution

setTestDisplayName

void setTestDisplayName(java.lang.String testDisplayName)

Sets the test display name for this execution

Parameters:

testDisplayName - the display name for the test in this execution.

setParentExecutionId

void setParentExecutionId(java.lang.String pParentExecutionId)

Sets the parent execution id

Parameters:

pParentExecutionId - the parent execution id

setStatus

void setStatus(java.lang.String pStatus)

Sets the status

Parameters:

pStatus - the status

setStartTime

void setStartTime(java.util.Date pStartTime)

Sets the start time

Parameters:

pStartTime - the start time

setEndTime

void setEndTime(java.util.Date pEndTime)

Sets the end time

Parameters:

pEndTime - the end time

setReport

void setReport(java.lang.String pReport)

Sets the report XML

Parameters:

pReport - the report XML

getViewReportAllowed

java.lang.Boolean getViewReportAllowed()

Specified by:

getViewReportAllowed in interface TestRunTreeNode

Returns:

whether viewing the report for a test's execution is allowed

setViewReportAllowed

void setViewReportAllowed(java.lang.Boolean pViewReportAllowed)

Parameters:

pViewReportAllowed - new value of whether a test's execution report can be viewed

setChildTestExecList

void setChildTestExecList(TestExecList childExecList)

Sets the list of child executions for this test if any

Parameters:

childExecList - the list of child executions for this test if any

copy

void copy(TestExec e)

Copies contents of the given TestExec object into this object

Parameters:

e - the source TestExec object to copy from

initializeReport

void initializeReport(java.lang.String pTestName,
                      java.lang.String pTestDisplayName,
                      java.lang.String pTestVersion)

Initializes the test report

initializeStepReport

void initializeStepReport(java.lang.String pStepName,
                          java.lang.String pExecName,
                          java.lang.String pExecType)

Initializes the step report for the given step name

Parameters:

pStepName - name of the step

pExecName - name of the executable that will get executed for the step.

pExecType - type of the executable for the step.

completeStepReport

void completeStepReport(java.lang.String pStepName)

Complets the step report for the given step

Parameters:

pStepName - name of the step to complete

addChild

void addChild(TestExec pChild)

Adds the given TestExec object to the list of this execution's child executions.

Parameters:

pChild - child execution to add.

fetch

void fetch()

Fetches the details of a particular test execution. Clients must set the execution ID on this object prior to calling this method by calling the setExecutionId() method. This method will also fetch the details of any child executions if available. The fetch will check for view report permission and will load the test report.

fetch

void fetch(boolean pFetchChildExecutions)

Fetches the details of a particular test execution. Clients must set the execution ID on this object prior to calling this method by calling the setExecutionId() method. This method will also fetch the details of any child executions if pFetchChildExecutions is true. The fetch will check for view report permission and will load the test report.

Parameters:

pFetchChildExecutions - if true, this method will additionally, also fetch details of any child executions. Otherwise fetches details for only the current execution.

fetch

void fetch(boolean pFetchChildExecutions,
           boolean bLoadReport)

Fetches the details of a particular test execution. Clients must set the execution ID on this object prior to calling this method by calling the setExecutionId() method. This method will also fetch the details of any child executions if pFetchChildExecutions is true.

Parameters:

pFetchChildExecutions - if true, this method will additionally, also fetch details of any child executions. Otherwise fetches details for only the current execution.

bLoadReport - if true, this method will check the view report permission and load the test report if it is allowed.

writeReportXML

java.lang.String writeReportXML(java.lang.String pOutDir,
                                boolean pWriteChildExecutions)

Writes the report for this execution to the given output directory. Additionally if pWriteChildExecutions is set to true, it will also write the reports for all nested executions (if any) to the output directory.

The filenames for the report files are based on the GUID for the execution.

Parameters:

pOutDir - output directory where the report file(s) are written to.

pWriteChildExecutions - if true writes the test reports for all nested executions in this execution. Otherwise writes only the report for this execution.

Returns:

the full file path of the output file where the report for this execution was written to.

writeReportXML

java.lang.String writeReportXML(java.lang.String pOutDir)

Writes the report for this execution as well as all included executions (if any) to the given output directory.

The file names for the report files are based on the GUIDs for the respective executions.

Parameters:

pOutDir - output directory where the report file(s) are written to.

Returns:

the full file path of the output file where the report for this execution was written to.

writeReportHTML

java.lang.String writeReportHTML(java.lang.String pOutDir,
                                 boolean pWriteChildExecutions)

Writes the contents of this execution's report in HTML format to the given output directory. Performs a XSL transformation in order to generate the HTML output.

Additionally if pWriteChildExecutions is set to true, it will also write the reports for all nested executions (if any) to the output directory.

The file names for the report files are based on the GUIDs for the respective executions.

Parameters:

pOutDir - output directory where the report files are generated.

pWriteChildExecutions - - if true writes the test reports for all nested executions in this execution. Otherwise writes only the report for this execution.

Returns:

the full file path to the output file.

writeReportHTML

java.lang.String writeReportHTML(java.lang.String pOutDir)

Writes the contents of this execution's report in HTML format to the given output directory. Performs a XSL transformation in order to generate the HTML output.

Additionally, this method also writes the reports for all nested executions (if any) to the output directory.

The file names for the report files are based on the GUIDs for the respective executions.

Parameters:

pOutDir - output directory where the report files are generated.

Returns:

the full file path to the output file.

writeReport

java.lang.String writeReport(java.lang.String pOutDir,
                             DiagConstants.Format pFormat)

Writes the contents of this execution's report in the specified format to the given output directory.

Additionally, this method also writes the reports for all nested executions (if any) to the output directory.

The file names for the report files are based on the GUIDs for the respective executions.

Parameters:

pOutDir - output directory where the report files are generated.

pFormat - format for the output e.g. XML or HTML.

Returns:

the full file path to the output file.

writeReport

java.lang.String writeReport(java.lang.String pOutDir,
                             boolean pWriteChildExecutions,
                             DiagConstants.Format pFormat)

Writes the contents of this execution's report in the specified format to the given output directory.

Additionally if pWriteChildExecutions is set to true, it will also write the reports for all nested executions (if any) to the output directory.

The file names for the report files are based on the GUIDs for the respective executions.

Parameters:

pOutDir - output directory where the report files are generated.

pWriteChildExecutions - - if true writes the test reports for all nested executions in this execution. Otherwise writes only the report for this execution.

pFormat - - Format for the output e.g. XML or HTML

Returns:

the full file path to the output file.

translateReport

void translateReport()

Translates the translatable contents of this report to user's session language.

computeLinksInReport

void computeLinksInReport()

Computes the links within the contents of this report as well as any nested reports.

visitAll

void visitAll(TestRun.TestRunVisitor pVisitor)

Traverses this Execution as well as all Exections under this Execution and invokes the appropriate "visit()" method on the TestRunVisitor for each node.

This method initially invokes pVisitor.visit(TestExec) with this execution object. Subsequently, it invokes pVisitor.visit(TestExec) for each nested execution (if any).

Parameters:

pVisitor - TestRunVisitor performing the visit on this run.