|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TestRun
Models a test run by the diagnostic engine.
Nested Class Summary | |
---|---|
static interface |
TestRun.ExecReportLinkProvider
Provides a call back API that clients can plug-in in order to compute the link to the reports for executions in this run during report extraction. |
static interface |
TestRun.TestRunVisitor
A callback interface for visiting multiple test run and/or executions. |
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 |
---|
Method Summary | |
---|---|
void |
cancel()
Attempts to cancel this test run by setting the status for this run to canceled in the test repository. |
void |
completeReport()
Completes the status for this run. |
void |
computeLinksInReport()
Computes the links within the contents of this report as well as any nested reports. |
void |
copy(TestRun t)
Copies the contents of the given TestRun into this object |
void |
delete()
Deletes the this test run. |
void |
fetch()
Fetches the contents of a TestRun. |
void |
fetch(boolean pFetchExecutions)
Fetches the contents of a TestRun. |
void |
fetch(boolean pFetchExecutions,
boolean bLoadReport)
Fetches the contents of a TestRun. |
java.lang.String |
generateXMLReport()
Generates the XML Report for the Run from the JAXB content tree and returns it as a String |
java.util.Date |
getEndTime()
Gets the end time |
java.lang.String |
getExecMode()
Gets the execution mode |
TestRun.ExecReportLinkProvider |
getExecReportLinkProvider()
Gets the execution report link provider that may have been set previously on this run by calling setExecReportLinkProvider(). |
int |
getMonitorInterval()
Get the Monitor interval Run Parameter for this run |
int |
getNumberOfThreads()
Get the Number of Threads Run Parameter for this run |
TestReportExtn |
getReportObj()
Return the report object for this run |
java.lang.String |
getRequestId()
Gets the request id |
java.lang.String |
getRunId()
Gets the run ID |
java.lang.String |
getRunName()
Gets the run description |
java.lang.String |
getRunReport()
Gets the run report |
java.util.Date |
getStartTime()
Gets the start time |
java.lang.String |
getStatus()
Gets the status |
TestExecList |
getTestExecList()
Returns the list of associated child executions |
java.lang.Boolean |
getViewReportAllowed()
Returns whether viewing the run report is allowed for the current user |
void |
initializeReport(NameValueList pRunArgs)
Initializes the run report and logs the given run arguments into the report. |
void |
logError(oracle.apps.fnd.appllcm.sdk.common.ResourceRef pErrMsg,
java.lang.Throwable t)
Logs the given error message and stack trace to the Run Report's Engine Log Section. |
void |
logMessage(oracle.apps.fnd.appllcm.sdk.common.ResourceRef pMsg)
Logs the given message to the Run Report's Engine Log Section. |
void |
setEndTime(java.util.Date pEndTime)
Sets the end time |
void |
setExecMode(java.lang.String pExecMode)
Sets the execution mode |
void |
setExecReportLinkProvider(TestRun.ExecReportLinkProvider provider)
Sets an execution report link provider for this run to be used in order to generate links to the execution reports for this run that can be embedded into this run report |
void |
setMonitorInterval(int value)
Set the Monitor interval Run Parameter for this run |
void |
setNumberOfThreads(int value)
Set the Number of Threads Run Parameter for this run |
void |
setRequestId(java.lang.String pRequestId)
Sets the request id |
void |
setRunId(java.lang.String pRunId)
Sets the Run ID |
void |
setRunName(java.lang.String pRunName)
Sets the run description |
void |
setRunReport(java.lang.String pRunReport)
Sets the run report |
void |
setStartTime(java.util.Date pStartTime)
Sets the start time |
void |
setStatus(java.lang.String pStatus)
Sets the status |
void |
setTestExecList(TestExecList pTestExecList)
Sets the test execution list for the test run |
void |
translateReport()
Translates the translatable contents of this report to user's session language. |
void |
visitAll(TestRun.TestRunVisitor pVisitor)
Traverses this Run as well as all Exections under this Run and invokes the appropriate "visit()" method on the TestRunVisitor for each node. |
java.lang.String |
writeReport(java.lang.String pOutDir,
boolean pWriteExecutions,
DiagConstants.Format pFormat)
Writes the contents of this run'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 run's report in the specified format to the given output directory. |
java.lang.String |
writeReportHTML(java.lang.String pOutDir)
Writes the contents of this run's report in HTML format to the given output directory. |
java.lang.String |
writeReportHTML(java.lang.String pOutDir,
boolean pWriteExecutions)
Writes the contents of this run's report in HTML format to the given output directory. |
java.lang.String |
writeReportXML(java.lang.String pOutDir)
Writes the report for this run as well as all included executions to the given output directory. |
java.lang.String |
writeReportXML(java.lang.String pOutDir,
boolean pWriteExecutions)
Writes the report for this run to the given output directory. |
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.TestMoniterable |
---|
checkCanceled, checkDone, 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, hasReport, isDone |
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.facade.DiagTreeNode |
---|
hasChildren |
Method Detail |
---|
java.lang.String getRunId()
java.lang.String getRunName()
java.lang.String getExecMode()
java.lang.String getStatus()
getStatus
in interface TestMoniterable<TestRun>
getStatus
in interface TestRunTreeNode
java.util.Date getStartTime()
getStartTime
in interface TestRunTreeNode
java.util.Date getEndTime()
getEndTime
in interface TestRunTreeNode
java.lang.String getRequestId()
java.lang.String getRunReport()
TestExecList getTestExecList()
int getMonitorInterval()
int getNumberOfThreads()
void setMonitorInterval(int value)
void setNumberOfThreads(int value)
void setRunId(java.lang.String pRunId)
pRunId
- the Run IDvoid setRunName(java.lang.String pRunName)
pRunName
- the run descriptionvoid setExecMode(java.lang.String pExecMode)
pExecMode
- the execution modevoid setStatus(java.lang.String pStatus)
pStatus
- the statusvoid setStartTime(java.util.Date pStartTime)
pStartTime
- the start timevoid setEndTime(java.util.Date pEndTime)
pEndTime
- the end timevoid setRequestId(java.lang.String pRequestId)
pRequestId
- the request idvoid setRunReport(java.lang.String pRunReport)
pRunReport
- the run reportjava.lang.Boolean getViewReportAllowed()
getViewReportAllowed
in interface TestRunTreeNode
void setTestExecList(TestExecList pTestExecList)
pTestExecList
- the run execution listvoid initializeReport(NameValueList pRunArgs)
pRunArgs
- parameter name values that were used to
invoke this run.void logMessage(oracle.apps.fnd.appllcm.sdk.common.ResourceRef pMsg)
pMsg
- Message to log.void logError(oracle.apps.fnd.appllcm.sdk.common.ResourceRef pErrMsg, java.lang.Throwable t)
pErrMsg
- Error message to logt
- Throwable whose stack trace will be logged.void completeReport()
void copy(TestRun t)
t
- The TestRun instance to copy from.void fetch()
void fetch(boolean pFetchExecutions)
pFetchExecutions
- flag to indicate whether the
API should fetch included executions or not. If false,
only fetches attributes of the run. Otherwise fetches
all incldues executions under this run as well.void fetch(boolean pFetchExecutions, boolean bLoadReport)
pFetchExecutions
- flag to indicate whether the
API should fetch included executions or not. If false,
only fetches attributes of the run. Otherwise fetches
all incldues executions under this run as well.bLoadReport
- flag to indicate whether the test
report should be loaded on the fetch. If it should be loaded,
the report view permission will be checked.java.lang.String generateXMLReport()
java.lang.String writeReportXML(java.lang.String pOutDir, boolean pWriteExecutions)
The filenames for the report files are based on the GUID for the run or execution.
pOutDir
- output directory where the report file(s) are
written to.pWriteExecutions
- if true
writes the test
reports for all executions in this run. Otherwise writes only
the report for this run.
java.lang.String writeReportXML(java.lang.String pOutDir)
The file names for the report files are based on the GUIDs for the respective runs or executions.
pOutDir
- output directory where the report file(s) are
written to.
java.lang.String writeReportHTML(java.lang.String pOutDir, boolean pWriteExecutions)
Additionally if pWriteExecutions is set to true, it will also write the reports for all included executions to the output directory.
The file names for the report files are based on the GUIDs for the respective run or execution(s).
pOutDir
- output directory where the report files are generated.pWriteExecutions
- - if true
writes the test
reports for all included executions in this run. Otherwise writes only
the report for this run.
java.lang.String writeReportHTML(java.lang.String pOutDir)
Additionally, this method also writes the reports for all included executions to the output directory.
The file names for the report files are based on the GUIDs for the respective run or execution(s).
pOutDir
- output directory where the report files are generated.
java.lang.String writeReport(java.lang.String pOutDir, DiagConstants.Format pFormat)
Additionally, this method also writes the reports for all included executions to the output directory.
The file names for the report files are based on the GUIDs for the respective run or execution(s).
pOutDir
- output directory where the report files are generated.pFormat
- format for the output e.g. XML or HTML
java.lang.String writeReport(java.lang.String pOutDir, boolean pWriteExecutions, DiagConstants.Format pFormat)
Additionally if pWriteExecutions is set to true, it will also write the reports for all included executions to the output directory.
The file names for the report files are based on the GUIDs for the respective run or execution(s).
pOutDir
- output directory where the report files are generated.pWriteExecutions
- - if true
writes the test
reports for all included executions in this run. Otherwise writes only
the report for this run.pFormat
- - Format for the output e.g. XML or HTML
TestReportExtn getReportObj()
void translateReport()
void computeLinksInReport()
void setExecReportLinkProvider(TestRun.ExecReportLinkProvider provider)
provider
- an instance of ExecReportLinkProvider that
can be used to create links to the execution reports.TestRun.ExecReportLinkProvider getExecReportLinkProvider()
void cancel()
void delete() throws DiagfwkException
DiagfwkException
- when any error occurs during the
deletion process.void visitAll(TestRun.TestRunVisitor pVisitor)
This method initially invokes pVisitor.visit(TestRun) with this run object. Subsequently, it invokes pVisitor.visit(TestExec) for each execution in the run including nested executions (if any).
pVisitor
- TestRunVisitor performing the visit
on this run.
|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |