Oracle Fusion Middleware extensions for Logging and Diagnostic
11g Release 1 (11.1.1.6)

E22565-06

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

All Superinterfaces:
DiagContext
All Known Implementing Classes:
DiagContextExtnImpl

public interface DiagContextExtn
extends DiagContext

This interface models the internal diagnostics execution context that is handed over to individual tests and test steps during their execution.

This interface extends the public DiagContext interface and is used internally by the diagnostics run command to interface with the diagnostics tests that it needs to run.

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/DiagContextExtn.java /main/10 2010/09/20 10:17:40 lwong Exp $
Author:
ppradhan

Field Summary
static java.lang.String DISPLAY
           
static java.lang.String INPUT
           
static java.lang.String INPUT_NO_VALUE
           
static java.lang.String KEY_CURRENT_STEP_NAME
          Key for the current step name
static java.lang.String KEY_DB_CONNECTION
          Key for the db connection
static java.lang.String KEY_PARENT_STACK
          Key for the stack of parent execution IDs
static java.lang.String KEY_RESULT_CODE
          Key for the result code
static java.lang.String KEY_STEP_REPORT
          Key for the step report
static java.lang.String KEY_TEST_EXEC_MONITOR_TP
          Key for the threadpool for monitoring individual test executions
static java.lang.String KEY_TEST_REPORT
          Key for the test report
static java.lang.String KEY_TEST_RUN
          Key for the test run
static java.lang.String OUTPUT
           
static java.lang.String OUTPUT_NO_VALUE
           
static java.lang.String SCOPE_STEP
          Top level scope for step level values
static java.lang.String SCOPE_TEST
          Scope name for the current test level values
static java.lang.String SCOPE_TEST_INPUT
          Scope name for test input
static java.lang.String SCOPE_TEST_INPUT_NO_VALUE
          Scope name for test input with no value specified
static java.lang.String SCOPE_TEST_OUTPUT
          Scope name for test output
static java.lang.String SCOPE_TEST_OUTPUT_NO_VALUE
          Scope name for test output with no value specified
static java.lang.String SK_DELIM
          Delimitor used internally to separate scope name from value key.
 
Method Summary
 void addInputParamCurrentExec(java.lang.String pParamName, java.lang.Object pParamValue)
          Sets the value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API.
 void addInputParamCurrentStep(java.lang.String pParamName, java.lang.Object pParamValue)
          Sets the value of the given input parameter for the current step in this test as determined by calling the getCurrentStepName() API.
 void addInputParamDisplayCurrentExec(java.lang.String pParamName, java.lang.String pParamDisplayName)
          Sets the displayName value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API.
 void addInputParamsTest(NameValueList pParams)
          Adds the given input parameters for this test into the context at the scope of the current test
 void addInputParamTest(java.lang.String pParamName, java.lang.Object pParamValue)
          Sets the value of the given input parameter for this test.
 void addOutputParam(java.lang.String pExecId, java.lang.String pStepName, java.lang.String pParamName, java.lang.Object pParamValue)
          Adds the given output paramter at the given execution and step scope.
 void addOutputParamCurrentExec(java.lang.String pParamName, java.lang.Object pParamValue)
          Sets the value of the given output parameter into the current execution scope
 void addOutputParamDisplayCurrentExec(java.lang.String pParamName, java.lang.String pParamDisplayName)
          Sets the displayName value of the given output parameter into the current execution scope
 void cleanup()
          Cleans up the existing state in this context.
 java.lang.Object get(java.lang.String pScope, java.lang.String pKey)
          Gets an object from the context under the given scope and with the given key
 java.lang.String getCurrentParentExecId()
          Gets the current execution's parent execution id.
 java.lang.String getCurrentParentStepName()
          Gets the current execution's parent step name.
 java.lang.String getCurrentStepName()
          Returns the name of the current step that is being executed for this test.
 java.lang.Object getCurrentStepOutputParam(java.lang.String pParamName)
          Gets the given output parameter value from the current step
 java.lang.Object getCurrentStepScope(java.lang.String pKey)
          Gets the object with the given key from the current execution and current step scope.
 TestExec getCurrentTestExec()
          Gets the TestExec object that represents the current execution
 java.lang.String getCurrentTestExecId()
          Gets the execution ID for the current execution
 java.lang.Object getCurrentTestExecScope(java.lang.String pKey)
          Gets the given object from the current test execution scope
 TestRun getCurrentTestRun()
          Returns the TestRun object that models the current test run.
 java.util.concurrent.ExecutorService getExecutorService()
          Gets the executor service from the context
 java.lang.Object getGlobal(java.lang.String pParam)
          Gets the value of the given parameter from the global scope
 java.lang.Object getInputParamCurrentExec(java.lang.String pParamName)
          Gets the value of the given input parameter from the current execution scope.
 java.lang.Object getInputParamCurrentStep(java.lang.String pParamName)
          Gets the value of the given input parameter from the current step scope.
 TestParam getInputParamDef(java.lang.String pParamName)
          Returns the definition for the input parameter with the given name
 java.lang.String getInputParamDisplayCurrentExec(java.lang.String pParamName)
          Gets the displayName value of the given input parameter from the current execution scope.
 java.lang.String getInputParamDisplayCurrentStep(java.lang.String pParamName)
          Gets the displayName value of the given input parameter from the current step scope.
 java.util.List<java.lang.String> getInputParamNamesCurrentExec()
          Returns the list of input parameter names at the current execution scope
 java.util.List<java.lang.String> getInputParamNamesCurrentStep()
          Returns the list of input parameter names at the current step scope
 java.util.List<java.lang.String> getInputParamNamesTest()
          Returns the list of input parameter names at the test scope
 java.lang.Object getInputParamTest(java.lang.String pParamName)
          Gets the input parameter with the given name from the test scope
 java.lang.Object getOutputParamCurrentExec(java.lang.String pParamName)
          Gets the value of the given output parameter from the current execution scope.
 java.lang.Object getOutputParamCurrentExecForStep(java.lang.String pStepName, java.lang.String pParamName)
          Gets the value of the given output parameter from the given step within the current execution scope.
 java.lang.Object getOutputParamCurrentStep(java.lang.String pParamName)
          Gets the value of the given output parameter from the current step scope
 TestParam getOutputParamDef(java.lang.String pParamName)
          Returns the definition for the output parameter with the given name
 java.lang.String getOutputParamDisplayCurrentExec(java.lang.String pParamName)
          Gets the displayName value of the given output parameter from the current execution scope.
 java.lang.String getOutputParamDisplayCurrentStep(java.lang.String pParamName)
          Gets the displayName value of the given output parameter from the current step scope
 java.util.List<java.lang.String> getOutputParamNamesCurrentExec()
          Returns the list of output parameter names at the current execution scope
 java.util.List<java.lang.String> getOutputParamNamesCurrentStep()
          Returns the list of output parameter names at the current step scope
 TestExec getRootTestExec()
          Gets the TestExec objec that represents the root execution
 java.lang.String getRootTestExecId()
          Gets the execution ID for the root execution that started this execution
 java.lang.String getScopeDelimitor()
          Returns the value of the delimitor used by the context
 java.lang.String getScopeNameExec(java.lang.String pExecId)
          Returns the name of the scope for the given execution id
 java.lang.String getScopeNameExecInput(java.lang.String pExecId)
          Returns the name for the input scope for the given execution id
 java.lang.String getScopeNameStep(java.lang.String pExecId, java.lang.String pStepName)
          Returns the name of the scope for the given execution id and the given step in the execution id
 java.lang.String getScopeNameStepInput(java.lang.String pExecId, java.lang.String pStepName)
          Returns the name of the input scope for the given execution id and given step in the execution id
 java.lang.String getScopeNameTestInput()
          Returns the name of the "test.input" scope
 java.lang.String getScopeNameTestOutput()
          Returns the name of the "test.output" scope
 StepReportExtn getStepReportExtn()
          Returns the internal interface to the current step report from the context.
 TestExec getTestExec(java.lang.String pExecId)
          Gets the TestExec object from the context with the given execution id
 TestReportExtn getTestReportExtn()
          Returns the internal interface to the current test report from the context
 java.util.List<java.lang.String> keys(java.lang.String pScope)
          Returns the keys for all the entities within the given scope
 java.lang.String popParentExecId()
          Pops the current parent execution Id from the stack of parent execution IDs.
 java.lang.String popParentStepName()
          Pops the current parent step name from the stack of parent step names.
 void pushParentExecId(java.lang.String pParentExecId)
          Pushes the given parent execution Id to the stack of parent execution Id's for the current execution.
 void pushParentStepName(java.lang.String pParentStepName)
          Pushes the given parent step name to the stack of parent step names for the current execution.
 void put(java.lang.String pScope, java.lang.String pKey, java.lang.Object pValue)
          Adds an object to the context under the given scope and with the given key.
 void putCurrentStepScope(java.lang.String pKey, java.lang.Object pValue)
          Puts the given object with the given key under the current execution and current step scope.
 void putCurrentTestExecScope(java.lang.String pKey, java.lang.Object pVal)
          Adds the given object into the current test execution scope.
 void putGlobal(java.lang.String pParam, java.lang.Object pVal)
          Puts the given object into the global scope of the context
 void remove(java.lang.String pScope, java.lang.String pKey)
          Removes an object from the context under the given scope and with the given key.
 void removeCurrentStepScope(java.lang.String pKey)
          Removes the object with the given key from the current execution and current step scope.
 void removeCurrentTestExecScope(java.lang.String pKey)
          Removes the object with the given key from the current test execution scope
 void setConnection(java.sql.Connection pConnection)
          Sets the Connection to the Applications database in the context for this test.
 void setCurrentStepName(java.lang.String pStepName)
          Sets the name of the current step that is going to be executed.
 void setCurrentTestExec(TestExec pExec)
          Sets the given TestExec object as the currently executing test
 void setCurrentTestRun(TestRun pTestrun)
          Sets the current run's TestRun object
 void setExecutorService(java.util.concurrent.ExecutorService pSvc)
          Sets the given executor service into the context.
 void setRootTestExec(TestExec pExec)
          Sets the given TestExec object as the root execution
 
Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.api.DiagContext
addOutputParam, getConnection, getInputParam, getInputParamNames, getStepReport, getTestReport
 

Field Detail

SK_DELIM

static final java.lang.String SK_DELIM
Delimitor used internally to separate scope name from value key.

See Also:
Constant Field Values

SCOPE_TEST

static final java.lang.String SCOPE_TEST
Scope name for the current test level values

See Also:
Constant Field Values

SCOPE_STEP

static final java.lang.String SCOPE_STEP
Top level scope for step level values

See Also:
Constant Field Values

INPUT

static final java.lang.String INPUT
See Also:
Constant Field Values

INPUT_NO_VALUE

static final java.lang.String INPUT_NO_VALUE
See Also:
Constant Field Values

OUTPUT

static final java.lang.String OUTPUT
See Also:
Constant Field Values

OUTPUT_NO_VALUE

static final java.lang.String OUTPUT_NO_VALUE
See Also:
Constant Field Values

DISPLAY

static final java.lang.String DISPLAY
See Also:
Constant Field Values

SCOPE_TEST_INPUT

static final java.lang.String SCOPE_TEST_INPUT
Scope name for test input

See Also:
Constant Field Values

SCOPE_TEST_INPUT_NO_VALUE

static final java.lang.String SCOPE_TEST_INPUT_NO_VALUE
Scope name for test input with no value specified

See Also:
Constant Field Values

SCOPE_TEST_OUTPUT

static final java.lang.String SCOPE_TEST_OUTPUT
Scope name for test output

See Also:
Constant Field Values

SCOPE_TEST_OUTPUT_NO_VALUE

static final java.lang.String SCOPE_TEST_OUTPUT_NO_VALUE
Scope name for test output with no value specified

See Also:
Constant Field Values

KEY_CURRENT_STEP_NAME

static final java.lang.String KEY_CURRENT_STEP_NAME
Key for the current step name

See Also:
Constant Field Values

KEY_TEST_REPORT

static final java.lang.String KEY_TEST_REPORT
Key for the test report

See Also:
Constant Field Values

KEY_STEP_REPORT

static final java.lang.String KEY_STEP_REPORT
Key for the step report

See Also:
Constant Field Values

KEY_DB_CONNECTION

static final java.lang.String KEY_DB_CONNECTION
Key for the db connection

See Also:
Constant Field Values

KEY_RESULT_CODE

static final java.lang.String KEY_RESULT_CODE
Key for the result code

See Also:
Constant Field Values

KEY_TEST_RUN

static final java.lang.String KEY_TEST_RUN
Key for the test run

See Also:
Constant Field Values

KEY_TEST_EXEC_MONITOR_TP

static final java.lang.String KEY_TEST_EXEC_MONITOR_TP
Key for the threadpool for monitoring individual test executions

See Also:
Constant Field Values

KEY_PARENT_STACK

static final java.lang.String KEY_PARENT_STACK
Key for the stack of parent execution IDs

See Also:
Constant Field Values
Method Detail

getCurrentStepName

java.lang.String getCurrentStepName()
Returns the name of the current step that is being executed for this test. The name of the step is defined in the diagnostic test definition metadata.

Returns:
the name of the current step that is being executed.

setCurrentStepName

void setCurrentStepName(java.lang.String pStepName)
Sets the name of the current step that is going to be executed. The name of the step is defined in the diagnostic tests definition metadata.

Parameters:
pStepName - the name of the current step that is being executed.

addInputParamsTest

void addInputParamsTest(NameValueList pParams)
Adds the given input parameters for this test into the context at the scope of the current test

Parameters:
pParams - the list of input parameters.

addInputParamTest

void addInputParamTest(java.lang.String pParamName,
                       java.lang.Object pParamValue)
Sets the value of the given input parameter for this test. The input parameter value is set at the scope of the current test.

Parameters:
pParamName - the name of the input parameter
pParamValue - the value for the input parameter.

addInputParamCurrentExec

void addInputParamCurrentExec(java.lang.String pParamName,
                              java.lang.Object pParamValue)
                              throws DiagfwkException
Sets the value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API.

The input parameter value is set at the scope of the current execution in the test.

Parameters:
pParamName - name of the parameter
pParamValue - value of the parameter.
Throws:
DiagfwkException - if the value of the current execution is not set prior to calling this API.

addInputParamDisplayCurrentExec

void addInputParamDisplayCurrentExec(java.lang.String pParamName,
                                     java.lang.String pParamDisplayName)
                                     throws DiagfwkException
Sets the displayName value of the given input parameter for the current execution in this context as determined by calling the getCurrentTestExecId() API.

The input parameter value is set at the scope of the current execution in the test.

Parameters:
pParamName - name of the parameter
pParamDisplayName - displayName value of the parameter.
Throws:
DiagfwkException - if the value of the current execution is not set prior to calling this API.

addOutputParamCurrentExec

void addOutputParamCurrentExec(java.lang.String pParamName,
                               java.lang.Object pParamValue)
                               throws DiagfwkException
Sets the value of the given output parameter into the current execution scope

Parameters:
pParamName - name of the parameter
pParamValue - value of the parameter
Throws:
DiagfwkException - in case of unsupported parameter type

addOutputParamDisplayCurrentExec

void addOutputParamDisplayCurrentExec(java.lang.String pParamName,
                                      java.lang.String pParamDisplayName)
                                      throws DiagfwkException
Sets the displayName value of the given output parameter into the current execution scope

Parameters:
pParamName - name of the parameter
pParamDisplayName - display value of the parameter
Throws:
DiagfwkException - in case of unsupported parameter type

addOutputParam

void addOutputParam(java.lang.String pExecId,
                    java.lang.String pStepName,
                    java.lang.String pParamName,
                    java.lang.Object pParamValue)
Adds the given output paramter at the given execution and step scope.

Parameters:
pExecId - ID for the execution scope to which to add the param
pStepName - name of the step scope to which to add the param
pParamName - name of the param
pParamValue - value for the param

addInputParamCurrentStep

void addInputParamCurrentStep(java.lang.String pParamName,
                              java.lang.Object pParamValue)
                              throws DiagfwkException
Sets the value of the given input parameter for the current step in this test as determined by calling the getCurrentStepName() API.

The input parameter value is set at the scope of the current step in the test.

Parameters:
pParamName - name of the parameter
pParamValue - value of the parameter.
Throws:
DiagfwkException - if the value of the current step is not set prior to calling this API.

put

void put(java.lang.String pScope,
         java.lang.String pKey,
         java.lang.Object pValue)
Adds an object to the context under the given scope and with the given key.

Parameters:
pScope - the name of the scope at which to set the object.
pKey - the name of the key
pValue - the value of the input parameter

get

java.lang.Object get(java.lang.String pScope,
                     java.lang.String pKey)
Gets an object from the context under the given scope and with the given key

Parameters:
pScope - scope for the object to get
pKey - key for the object to get
Returns:
object in the context under the given scope and with the given key.

remove

void remove(java.lang.String pScope,
            java.lang.String pKey)
Removes an object from the context under the given scope and with the given key.

Parameters:
pScope - the scope name for the object to remove.
pKey - the key for the object to remove.

setConnection

void setConnection(java.sql.Connection pConnection)
Sets the Connection to the Applications database in the context for this test.

Parameters:
pConnection - connection to the Applications database.

cleanup

void cleanup()
Cleans up the existing state in this context.


getCurrentStepOutputParam

java.lang.Object getCurrentStepOutputParam(java.lang.String pParamName)
Gets the given output parameter value from the current step

Parameters:
pParamName - name of the output parameter
Returns:
output parameter value

getScopeNameTestInput

java.lang.String getScopeNameTestInput()
Returns the name of the "test.input" scope

Returns:
the name of the "test.input" scope

getScopeNameTestOutput

java.lang.String getScopeNameTestOutput()
Returns the name of the "test.output" scope

Returns:
the name of the "test.output" scope

getScopeNameExecInput

java.lang.String getScopeNameExecInput(java.lang.String pExecId)
Returns the name for the input scope for the given execution id

Parameters:
pExecId - execution id
Returns:
the name for the input scope for the given execution id

getScopeNameExec

java.lang.String getScopeNameExec(java.lang.String pExecId)
Returns the name of the scope for the given execution id

Parameters:
pExecId - execution id
Returns:
the name of the scope for the given execution id.

getScopeNameStepInput

java.lang.String getScopeNameStepInput(java.lang.String pExecId,
                                       java.lang.String pStepName)
Returns the name of the input scope for the given execution id and given step in the execution id

Parameters:
pExecId - execution id
pStepName - name of the step
Returns:
the name of the input scope for the given execution id and given step in the execution id

getScopeNameStep

java.lang.String getScopeNameStep(java.lang.String pExecId,
                                  java.lang.String pStepName)
Returns the name of the scope for the given execution id and the given step in the execution id

Parameters:
pExecId - execution id
pStepName - name of the step in the execution id
Returns:
the name of the scope for the given execution id and the given step in the execution id

getScopeDelimitor

java.lang.String getScopeDelimitor()
Returns the value of the delimitor used by the context

Returns:
the value of delimitor used by the context.

getCurrentTestRun

TestRun getCurrentTestRun()
Returns the TestRun object that models the current test run.

Returns:
the current test run

setCurrentTestRun

void setCurrentTestRun(TestRun pTestrun)
Sets the current run's TestRun object

Parameters:
pTestrun - current run's TestRun object

getCurrentTestExec

TestExec getCurrentTestExec()
Gets the TestExec object that represents the current execution

Returns:
the current test execution

getTestExec

TestExec getTestExec(java.lang.String pExecId)
Gets the TestExec object from the context with the given execution id

Parameters:
pExecId - the execution id for the TestExec object to get from the context
Returns:
the TestExec object from the context with the given execution id

getRootTestExec

TestExec getRootTestExec()
Gets the TestExec objec that represents the root execution

Returns:
the TestExec object that represents the root execution

getCurrentTestExecId

java.lang.String getCurrentTestExecId()
Gets the execution ID for the current execution

Returns:
the current test execution ID

getRootTestExecId

java.lang.String getRootTestExecId()
Gets the execution ID for the root execution that started this execution

Returns:
the execution ID for the root execution

setRootTestExec

void setRootTestExec(TestExec pExec)
Sets the given TestExec object as the root execution

Parameters:
pExec -

setCurrentTestExec

void setCurrentTestExec(TestExec pExec)
Sets the given TestExec object as the currently executing test

Parameters:
pExec - currently executing TestExec object

getCurrentParentExecId

java.lang.String getCurrentParentExecId()
Gets the current execution's parent execution id. Returns null if there is no parent

Returns:
the current execution's parent execution id. Returns null if there is no parent.

pushParentExecId

void pushParentExecId(java.lang.String pParentExecId)
Pushes the given parent execution Id to the stack of parent execution Id's for the current execution. If a stack does not yet exist, this method will also initialize that stack in the context.

Parameters:
pParentExecId - execution Id to push to the stack of parent execution IDs.

popParentExecId

java.lang.String popParentExecId()
Pops the current parent execution Id from the stack of parent execution IDs.

Returns:
the popped parent execution id.

getGlobal

java.lang.Object getGlobal(java.lang.String pParam)
Gets the value of the given parameter from the global scope

Parameters:
pParam - name of the parameter
Returns:
the value of the given parameter from the global scope

putGlobal

void putGlobal(java.lang.String pParam,
               java.lang.Object pVal)
Puts the given object into the global scope of the context

Parameters:
pParam - parameter name
pVal - value for the parameter

putCurrentTestExecScope

void putCurrentTestExecScope(java.lang.String pKey,
                             java.lang.Object pVal)
Adds the given object into the current test execution scope.

Parameters:
pKey - key for the object
pVal - object to be added into the current test execution scope.

getCurrentTestExecScope

java.lang.Object getCurrentTestExecScope(java.lang.String pKey)
Gets the given object from the current test execution scope

Parameters:
pKey - the key for the object
Returns:
the object with the given key from the current test execution scope

removeCurrentTestExecScope

void removeCurrentTestExecScope(java.lang.String pKey)
Removes the object with the given key from the current test execution scope

Parameters:
pKey - the key for the object to remove

setExecutorService

void setExecutorService(java.util.concurrent.ExecutorService pSvc)
Sets the given executor service into the context.

Parameters:
pSvc - executor service

getExecutorService

java.util.concurrent.ExecutorService getExecutorService()
Gets the executor service from the context

Returns:
an executor service

getInputParamTest

java.lang.Object getInputParamTest(java.lang.String pParamName)
Gets the input parameter with the given name from the test scope

Parameters:
pParamName - name of the parameter
Returns:
the parameter with the given name from the test scope

getInputParamCurrentExec

java.lang.Object getInputParamCurrentExec(java.lang.String pParamName)
Gets the value of the given input parameter from the current execution scope.

Parameters:
pParamName - name of the parameter
Returns:
the parameter with the given name from the current execution scope.

getInputParamDisplayCurrentExec

java.lang.String getInputParamDisplayCurrentExec(java.lang.String pParamName)
Gets the displayName value of the given input parameter from the current execution scope.

Parameters:
pParamName - name of the parameter
Returns:
the parameter displayName with the given name from the current execution scope.

getInputParamCurrentStep

java.lang.Object getInputParamCurrentStep(java.lang.String pParamName)
Gets the value of the given input parameter from the current step scope.

Parameters:
pParamName - name of the parameter
Returns:
the parameter with the given name from the current step scope.

getInputParamDisplayCurrentStep

java.lang.String getInputParamDisplayCurrentStep(java.lang.String pParamName)
Gets the displayName value of the given input parameter from the current step scope.

Parameters:
pParamName - name of the parameter
Returns:
the parameter displayName with the given name from the current step scope.

getOutputParamCurrentExec

java.lang.Object getOutputParamCurrentExec(java.lang.String pParamName)
Gets the value of the given output parameter from the current execution scope.

Parameters:
pParamName - name of the output parameter
Returns:
the output parameter value with the given name from the current execution scope.

getOutputParamDisplayCurrentExec

java.lang.String getOutputParamDisplayCurrentExec(java.lang.String pParamName)
Gets the displayName value of the given output parameter from the current execution scope.

Parameters:
pParamName - name of the output parameter
Returns:
the output parameter displayName value with the given name from the current execution scope.

getOutputParamCurrentStep

java.lang.Object getOutputParamCurrentStep(java.lang.String pParamName)
Gets the value of the given output parameter from the current step scope

Parameters:
pParamName - name of the output parameter
Returns:
value of the output parameter

getOutputParamDisplayCurrentStep

java.lang.String getOutputParamDisplayCurrentStep(java.lang.String pParamName)
Gets the displayName value of the given output parameter from the current step scope

Parameters:
pParamName - name of the output parameter
Returns:
value of the output parameter displayName

getOutputParamCurrentExecForStep

java.lang.Object getOutputParamCurrentExecForStep(java.lang.String pStepName,
                                                  java.lang.String pParamName)
Gets the value of the given output parameter from the given step within the current execution scope.

Parameters:
pStepName - name of the step from which to get the output parameter
pParamName - name of the output parameter
Returns:
the output parameter value for parameter with the given name from the given step in the current execution scope.

getInputParamNamesTest

java.util.List<java.lang.String> getInputParamNamesTest()
Returns the list of input parameter names at the test scope

Returns:
the list of input parameter names at the test scope

getInputParamDef

TestParam getInputParamDef(java.lang.String pParamName)
Returns the definition for the input parameter with the given name

Parameters:
pParamName - name of parameter
Returns:
the definition for the input parameter with the given name, null if no such parameter found

getInputParamNamesCurrentExec

java.util.List<java.lang.String> getInputParamNamesCurrentExec()
Returns the list of input parameter names at the current execution scope

Returns:
the list of input parameter names at the current execution scope

getOutputParamNamesCurrentExec

java.util.List<java.lang.String> getOutputParamNamesCurrentExec()
Returns the list of output parameter names at the current execution scope

Returns:
the list of output paramter names at the current execution scope.

getOutputParamDef

TestParam getOutputParamDef(java.lang.String pParamName)
Returns the definition for the output parameter with the given name

Parameters:
pParamName - name of parameter
Returns:
the definition for the output parameter with the given name, null if no such parameter found

getInputParamNamesCurrentStep

java.util.List<java.lang.String> getInputParamNamesCurrentStep()
Returns the list of input parameter names at the current step scope

Returns:
the list of input parameter names at the current step scope

getOutputParamNamesCurrentStep

java.util.List<java.lang.String> getOutputParamNamesCurrentStep()
Returns the list of output parameter names at the current step scope

Returns:
the list of output parameter names at the current step scope

keys

java.util.List<java.lang.String> keys(java.lang.String pScope)
Returns the keys for all the entities within the given scope

Parameters:
pScope - name of the scope
Returns:
the keys for all the entities within the given scope

putCurrentStepScope

void putCurrentStepScope(java.lang.String pKey,
                         java.lang.Object pValue)
Puts the given object with the given key under the current execution and current step scope.

Parameters:
pKey - key for the object
pValue - the object to store in the context

getCurrentStepScope

java.lang.Object getCurrentStepScope(java.lang.String pKey)
Gets the object with the given key from the current execution and current step scope.

Parameters:
pKey - key for the object to retrieve
Returns:
the object with the given key retrieved from the current execution and current step scope.

removeCurrentStepScope

void removeCurrentStepScope(java.lang.String pKey)
Removes the object with the given key from the current execution and current step scope.

Parameters:
pKey - key for the object to remove

getCurrentParentStepName

java.lang.String getCurrentParentStepName()
Gets the current execution's parent step name. Returns null if there is no parent

Returns:
the current execution's parent step name. Returns null if there is no parent.

pushParentStepName

void pushParentStepName(java.lang.String pParentStepName)
Pushes the given parent step name to the stack of parent step names for the current execution. If a stack does not yet exist, this method will also initialize that stack in the context.

Parameters:
pParentStepName - step name to push to the stack of parent step names

popParentStepName

java.lang.String popParentStepName()
Pops the current parent step name from the stack of parent step names.

Returns:
the popped parent step name.

getStepReportExtn

StepReportExtn getStepReportExtn()
Returns the internal interface to the current step report from the context.

Returns:
the current step report.

getTestReportExtn

TestReportExtn getTestReportExtn()
Returns the internal interface to the current test report from the context

Returns:
the current test report

Oracle Fusion Middleware extensions for Logging and Diagnostic
11g Release 1 (11.1.1.6)

E22565-06

Copyright © 2012 Oracle. All Rights Reserved.