|
Oracle Fusion Middleware extensions for Logging and Diagnostics 11g Release 1 (11.1.2) E22565-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StepReportExtn
EXtension interface to the StepReport interface. Provides internal engine APIs for setting additional details on the step report during 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 |
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 |
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 |
---|
void setStepName(java.lang.String pStepName)
pStepName
- the name of the stepvoid setExecutableName(java.lang.String pExecutableName)
pExecutableName
- name of the executable for this step.void setExecutableType(java.lang.String pExecutableType)
pExecutableType
- the type of the executable for this step.void setStartDate(java.util.Date pStartDate)
pStartDate
- the start date/time for this stepvoid setEndDate(java.util.Date pEndDate)
pEndDate
- the end date/time for this stepvoid setExecutionId(java.lang.String pExecutionId)
pExecutionId
- the execution ID for this step.void setStatusCode(DiagConstants.Status pStautsCode)
pStautsCode
- the status code for this reportvoid addInputParameter(NameValue pParam)
pParam
- an input parameter for this stepvoid addInputParameterList(NameValueList pParamList)
pParamList
- input parameter listvoid addOutputParameter(NameValue pParam)
pParam
- an output parameter for this step.void addOutputParameterList(NameValueList pParamList)
pParamList
- output parmater list.java.lang.String getStepName()
java.lang.String getExecutableName()
java.lang.String getExecutableType()
java.util.Date getStartDate()
java.util.Date getEndDate()
java.lang.String getExecutionId()
DiagConstants.Status getStatusCode()
NameValueList getInputParameterList()
NameValueList getOutputParameterList()
void addExecutionError(java.lang.Throwable t)
t
- Throwable representing the execution error.void addErrorInfo(ErrorInfo pErrorInfo)
pErrorInfo
- error information to be added to the report.StepReportType getJAXBMetadataObj()
void setJAXBMetadataObj(StepReportType pObj)
pObj
- the underlying JAXB StepReport object for this reportDiagConstants.Status computeStatus()
void addStepReport(StepReport pStepReport)
pStepReport
- the nested step report to add.java.util.List<Container> getContents()
|
Oracle Fusion Middleware extensions for Logging and Diagnostics 11g Release 1 (11.1.2) E22565-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |