oracle.apps.fnd.appltest.diagfwk.engine.impl
Class DiagContextExtnImpl

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagContextExtnImpl

All Implemented Interfaces:

DiagContext, DiagContextExtn

public class DiagContextExtnImpl
extends java.lang.Object
implements DiagContextExtn

A context hashtable to hold input parameters, output parameters or any other context specific information required during the execution of the test.

Entities are stored in the context using a scope and a key.

Scopes exist at the following levels:

• test - entities stored at the test scope are global to the root execution for this context
• execution - each execution including the root execution has its own scope that is striped using the current execution ID. Additionlly for nested executions, one can also get the parent execution ID by calling the getCurrentParentExecId() method.
• step - within a given execution, each step for the test has its scope that is further striped using the step name.

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

Author:

ppradhan

Field Summary

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagContextExtn

DISPLAY, INPUT, INPUT_NO_VALUE, KEY_CURRENT_STEP_NAME, KEY_DB_CONNECTION, KEY_PARENT_STACK, KEY_RESULT_CODE, KEY_STEP_REPORT, KEY_TEST_EXEC_MONITOR_TP, KEY_TEST_REPORT, KEY_TEST_RUN, OUTPUT, OUTPUT_NO_VALUE, SCOPE_STEP, SCOPE_TEST, SCOPE_TEST_INPUT, SCOPE_TEST_INPUT_NO_VALUE, SCOPE_TEST_OUTPUT, SCOPE_TEST_OUTPUT_NO_VALUE, SK_DELIM

Constructor Summary

DiagContextExtnImpl()

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	addInputParamDisplayCurrentStep(java.lang.String pParamName, java.lang.String pParamDisplayName)
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 pParamName, java.lang.Object pParamValue) Sets the value of the given output 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	addOutputParamDisplay(java.lang.String pParamName, java.lang.String pParamDisplayName)
void	addOutputParamDisplay(java.lang.String pExecId, java.lang.String pStepName, java.lang.String pParamName, java.lang.String pParamDisplayName)
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.
boolean	exists(java.lang.String pScope, java.lang.String pKey) Checks to see if an object exists in the context with the given scope and key.
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.sql.Connection	getConnection() Returns a Connection to the Applications database
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	getInputParam(java.lang.String pParamName) Returns the value of the given input parameter for this test step.
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>	getInputParamNames() Returns the list of names of input parameters that are available for the current test step.
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
StepReport	getStepReport() Returns the report for the current step
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
TestReport	getTestReport() Returns the overall report for the current test
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
protected void	setTestExec(TestExec pObj)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiagContextExtnImpl

public DiagContextExtnImpl()

Method Detail

getCurrentStepName

public java.lang.String getCurrentStepName()

Description copied from interface: DiagContextExtn

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.

Specified by:

getCurrentStepName in interface DiagContextExtn

Returns:

the name of the current step that is being executed.

setCurrentStepName

public void setCurrentStepName(java.lang.String pStepName)

Description copied from interface: DiagContextExtn

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.

Specified by:

setCurrentStepName in interface DiagContextExtn

Parameters:

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

addInputParamsTest

public void addInputParamsTest(NameValueList pParams)

Description copied from interface: DiagContextExtn

Adds the given input parameters for this test into the context at the scope of the current test

Specified by:

addInputParamsTest in interface DiagContextExtn

Parameters:

pParams - the list of input parameters.

addInputParamTest

public void addInputParamTest(java.lang.String pParamName,
                              java.lang.Object pParamValue)

Description copied from interface: DiagContextExtn

Sets the value of the given input parameter for this test. The input parameter value is set at the scope of the current test.

Specified by:

addInputParamTest in interface DiagContextExtn

Parameters:

pParamName - the name of the input parameter

pParamValue - the value for the input parameter.

addInputParamCurrentExec

public void addInputParamCurrentExec(java.lang.String pParamName,
                                     java.lang.Object pParamValue)
                              throws DiagfwkException

Description copied from interface: DiagContextExtn

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.

Specified by:

addInputParamCurrentExec in interface DiagContextExtn

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

public void addInputParamDisplayCurrentExec(java.lang.String pParamName,
                                            java.lang.String pParamDisplayName)
                                     throws DiagfwkException

Description copied from interface: DiagContextExtn

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.

Specified by:

addInputParamDisplayCurrentExec in interface DiagContextExtn

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

public void addOutputParamCurrentExec(java.lang.String pParamName,
                                      java.lang.Object pParamValue)
                               throws DiagfwkException

Description copied from interface: DiagContextExtn

Sets the value of the given output parameter into the current execution scope

Specified by:

addOutputParamCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

pParamValue - value of the parameter

Throws:

DiagfwkException - in case of unsupported parameter type

addOutputParamDisplayCurrentExec

public void addOutputParamDisplayCurrentExec(java.lang.String pParamName,
                                             java.lang.String pParamDisplayName)
                                      throws DiagfwkException

Description copied from interface: DiagContextExtn

Sets the displayName value of the given output parameter into the current execution scope

Specified by:

addOutputParamDisplayCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

pParamDisplayName - display value of the parameter

Throws:

DiagfwkException - in case of unsupported parameter type

addInputParamCurrentStep

public void addInputParamCurrentStep(java.lang.String pParamName,
                                     java.lang.Object pParamValue)
                              throws DiagfwkException

Description copied from interface: DiagContextExtn

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.

Specified by:

addInputParamCurrentStep in interface DiagContextExtn

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.

addInputParamDisplayCurrentStep

public void addInputParamDisplayCurrentStep(java.lang.String pParamName,
                                            java.lang.String pParamDisplayName)
                                     throws DiagfwkException

Throws:

DiagfwkException

setConnection

public void setConnection(java.sql.Connection pConnection)

Description copied from interface: DiagContextExtn

Sets the Connection to the Applications database in the context for this test.

Specified by:

setConnection in interface DiagContextExtn

Parameters:

pConnection - connection to the Applications database.

cleanup

public void cleanup()

Description copied from interface: DiagContextExtn

Cleans up the existing state in this context.

Specified by:

cleanup in interface DiagContextExtn

getInputParam

public java.lang.Object getInputParam(java.lang.String pParamName)

Description copied from interface: DiagContext

Returns the value of the given input parameter for this test step.

Specified by:

getInputParam in interface DiagContext

Parameters:

pParamName - the name of the input parameter

Returns:

the value of the given input parameter.

addOutputParam

public void addOutputParam(java.lang.String pParamName,
                           java.lang.Object pParamValue)

Description copied from interface: DiagContext

Sets the value of the given output parameter for this test.

Specified by:

addOutputParam in interface DiagContext

Parameters:

pParamName - the name of the output parameter

pParamValue - the value for the output parameter.

addOutputParamDisplay

public void addOutputParamDisplay(java.lang.String pParamName,
                                  java.lang.String pParamDisplayName)

getCurrentStepOutputParam

public java.lang.Object getCurrentStepOutputParam(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the given output parameter value from the current step

Specified by:

getCurrentStepOutputParam in interface DiagContextExtn

Parameters:

pParamName - name of the output parameter

Returns:

output parameter value

getTestReport

public TestReport getTestReport()

Description copied from interface: DiagContext

Returns the overall report for the current test

Specified by:

getTestReport in interface DiagContext

Returns:

the report for the current test.

getTestReportExtn

public TestReportExtn getTestReportExtn()

Description copied from interface: DiagContextExtn

Returns the internal interface to the current test report from the context

Specified by:

getTestReportExtn in interface DiagContextExtn

Returns:

the current test report

getStepReport

public StepReport getStepReport()

Description copied from interface: DiagContext

Returns the report for the current step

Specified by:

getStepReport in interface DiagContext

Returns:

the report for the current step.

getConnection

public java.sql.Connection getConnection()

Description copied from interface: DiagContext

Returns a Connection to the Applications database

Specified by:

getConnection in interface DiagContext

Returns:

a Connection to the Applicatoins database.

put

public void put(java.lang.String pScope,
                java.lang.String pKey,
                java.lang.Object pValue)

Description copied from interface: DiagContextExtn

Adds an object to the context under the given scope and with the given key.

Specified by:

put in interface DiagContextExtn

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

public java.lang.Object get(java.lang.String pScope,
                            java.lang.String pKey)

Description copied from interface: DiagContextExtn

Gets an object from the context under the given scope and with the given key

Specified by:

get in interface DiagContextExtn

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

public void remove(java.lang.String pScope,
                   java.lang.String pKey)

Description copied from interface: DiagContextExtn

Removes an object from the context under the given scope and with the given key.

Specified by:

remove in interface DiagContextExtn

Parameters:

pScope - the scope name for the object to remove.

pKey - the key for the object to remove.

exists

public boolean exists(java.lang.String pScope,
                      java.lang.String pKey)

Checks to see if an object exists in the context with the given scope and key.

Parameters:

pScope -

pKey -

Returns:

getScopeNameTestInput

public java.lang.String getScopeNameTestInput()

Returns the name of the "test.input" scope

Specified by:

getScopeNameTestInput in interface DiagContextExtn

Returns:

the name of the "test.input" scope

getScopeNameTestOutput

public java.lang.String getScopeNameTestOutput()

Returns the name of the "test.output" scope

Specified by:

getScopeNameTestOutput in interface DiagContextExtn

Returns:

the name of the "test.output" scope

getScopeNameExecInput

public java.lang.String getScopeNameExecInput(java.lang.String pExecId)

Description copied from interface: DiagContextExtn

Returns the name for the input scope for the given execution id

Specified by:

getScopeNameExecInput in interface DiagContextExtn

Parameters:

pExecId - execution id

Returns:

the name for the input scope for the given execution id

getScopeNameExec

public java.lang.String getScopeNameExec(java.lang.String pExecId)

Description copied from interface: DiagContextExtn

Returns the name of the scope for the given execution id

Specified by:

getScopeNameExec in interface DiagContextExtn

Parameters:

pExecId - execution id

Returns:

the name of the scope for the given execution id.

getScopeNameStepInput

public java.lang.String getScopeNameStepInput(java.lang.String pExecId,
                                              java.lang.String pStepName)

Description copied from interface: DiagContextExtn

Returns the name of the input scope for the given execution id and given step in the execution id

Specified by:

getScopeNameStepInput in interface DiagContextExtn

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

public java.lang.String getScopeNameStep(java.lang.String pExecId,
                                         java.lang.String pStepName)

Description copied from interface: DiagContextExtn

Returns the name of the scope for the given execution id and the given step in the execution id

Specified by:

getScopeNameStep in interface DiagContextExtn

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

public java.lang.String getScopeDelimitor()

Returns the value of the delimitor used by the context

Specified by:

getScopeDelimitor in interface DiagContextExtn

Returns:

the value of delimitor used by the context.

getCurrentTestRun

public TestRun getCurrentTestRun()

Description copied from interface: DiagContextExtn

Returns the TestRun object that models the current test run.

Specified by:

getCurrentTestRun in interface DiagContextExtn

Returns:

the current test run

setCurrentTestRun

public void setCurrentTestRun(TestRun pTestRun)

Description copied from interface: DiagContextExtn

Sets the current run's TestRun object

Specified by:

setCurrentTestRun in interface DiagContextExtn

Parameters:

pTestRun - current run's TestRun object

getTestExec

public TestExec getTestExec(java.lang.String pExecId)

Description copied from interface: DiagContextExtn

Gets the TestExec object from the context with the given execution id

Specified by:

getTestExec in interface DiagContextExtn

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

setTestExec

protected void setTestExec(TestExec pObj)

getCurrentTestExec

public TestExec getCurrentTestExec()

Description copied from interface: DiagContextExtn

Gets the TestExec object that represents the current execution

Specified by:

getCurrentTestExec in interface DiagContextExtn

Returns:

the current test execution

getRootTestExec

public TestExec getRootTestExec()

Description copied from interface: DiagContextExtn

Gets the TestExec objec that represents the root execution

Specified by:

getRootTestExec in interface DiagContextExtn

Returns:

the TestExec object that represents the root execution

getCurrentTestExecId

public java.lang.String getCurrentTestExecId()

Description copied from interface: DiagContextExtn

Gets the execution ID for the current execution

Specified by:

getCurrentTestExecId in interface DiagContextExtn

Returns:

the current test execution ID

getRootTestExecId

public java.lang.String getRootTestExecId()

Description copied from interface: DiagContextExtn

Gets the execution ID for the root execution that started this execution

Specified by:

getRootTestExecId in interface DiagContextExtn

Returns:

the execution ID for the root execution

setRootTestExec

public void setRootTestExec(TestExec pExec)

Description copied from interface: DiagContextExtn

Sets the given TestExec object as the root execution

Specified by:

setRootTestExec in interface DiagContextExtn

setCurrentTestExec

public void setCurrentTestExec(TestExec pExec)

Description copied from interface: DiagContextExtn

Sets the given TestExec object as the currently executing test

Specified by:

setCurrentTestExec in interface DiagContextExtn

Parameters:

pExec - currently executing TestExec object

getCurrentParentExecId

public java.lang.String getCurrentParentExecId()

Description copied from interface: DiagContextExtn

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

Specified by:

getCurrentParentExecId in interface DiagContextExtn

Returns:

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

pushParentExecId

public void pushParentExecId(java.lang.String pParentExecId)

Description copied from interface: DiagContextExtn

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.

Specified by:

pushParentExecId in interface DiagContextExtn

Parameters:

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

popParentExecId

public java.lang.String popParentExecId()

Description copied from interface: DiagContextExtn

Pops the current parent execution Id from the stack of parent execution IDs.

Specified by:

popParentExecId in interface DiagContextExtn

Returns:

the popped parent execution id.

getGlobal

public java.lang.Object getGlobal(java.lang.String pParam)

Description copied from interface: DiagContextExtn

Gets the value of the given parameter from the global scope

Specified by:

getGlobal in interface DiagContextExtn

Parameters:

pParam - name of the parameter

Returns:

the value of the given parameter from the global scope

putGlobal

public void putGlobal(java.lang.String pParam,
                      java.lang.Object pVal)

Description copied from interface: DiagContextExtn

Puts the given object into the global scope of the context

Specified by:

putGlobal in interface DiagContextExtn

Parameters:

pParam - parameter name

pVal - value for the parameter

putCurrentTestExecScope

public void putCurrentTestExecScope(java.lang.String pKey,
                                    java.lang.Object pVal)

Description copied from interface: DiagContextExtn

Adds the given object into the current test execution scope.

Specified by:

putCurrentTestExecScope in interface DiagContextExtn

Parameters:

pKey - key for the object

pVal - object to be added into the current test execution scope.

getCurrentTestExecScope

public java.lang.Object getCurrentTestExecScope(java.lang.String pKey)

Description copied from interface: DiagContextExtn

Gets the given object from the current test execution scope

Specified by:

getCurrentTestExecScope in interface DiagContextExtn

Parameters:

pKey - the key for the object

Returns:

the object with the given key from the current test execution scope

removeCurrentTestExecScope

public void removeCurrentTestExecScope(java.lang.String pKey)

Description copied from interface: DiagContextExtn

Removes the object with the given key from the current test execution scope

Specified by:

removeCurrentTestExecScope in interface DiagContextExtn

Parameters:

pKey - the key for the object to remove

setExecutorService

public void setExecutorService(java.util.concurrent.ExecutorService pSvc)

Description copied from interface: DiagContextExtn

Sets the given executor service into the context.

Specified by:

setExecutorService in interface DiagContextExtn

Parameters:

pSvc - executor service

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Description copied from interface: DiagContextExtn

Gets the executor service from the context

Specified by:

getExecutorService in interface DiagContextExtn

Returns:

an executor service

getInputParamTest

public java.lang.Object getInputParamTest(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the input parameter with the given name from the test scope

Specified by:

getInputParamTest in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

Returns:

the parameter with the given name from the test scope

getInputParamCurrentExec

public java.lang.Object getInputParamCurrentExec(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the value of the given input parameter from the current execution scope.

Specified by:

getInputParamCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

Returns:

the parameter with the given name from the current execution scope.

getInputParamDisplayCurrentExec

public java.lang.String getInputParamDisplayCurrentExec(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the displayName value of the given input parameter from the current execution scope.

Specified by:

getInputParamDisplayCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

Returns:

the parameter displayName with the given name from the current execution scope.

getInputParamCurrentStep

public java.lang.Object getInputParamCurrentStep(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the value of the given input parameter from the current step scope.

Specified by:

getInputParamCurrentStep in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

Returns:

the parameter with the given name from the current step scope.

getInputParamDisplayCurrentStep

public java.lang.String getInputParamDisplayCurrentStep(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the displayName value of the given input parameter from the current step scope.

Specified by:

getInputParamDisplayCurrentStep in interface DiagContextExtn

Parameters:

pParamName - name of the parameter

Returns:

the parameter displayName with the given name from the current step scope.

getOutputParamCurrentExec

public java.lang.Object getOutputParamCurrentExec(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the value of the given output parameter from the current execution scope.

Specified by:

getOutputParamCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the output parameter

Returns:

the output parameter value with the given name from the current execution scope.

getOutputParamDisplayCurrentExec

public java.lang.String getOutputParamDisplayCurrentExec(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the displayName value of the given output parameter from the current execution scope.

Specified by:

getOutputParamDisplayCurrentExec in interface DiagContextExtn

Parameters:

pParamName - name of the output parameter

Returns:

the output parameter displayName value with the given name from the current execution scope.

getOutputParamCurrentStep

public java.lang.Object getOutputParamCurrentStep(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the value of the given output parameter from the current step scope

Specified by:

getOutputParamCurrentStep in interface DiagContextExtn

Parameters:

pParamName - name of the output parameter

Returns:

value of the output parameter

getOutputParamDisplayCurrentStep

public java.lang.String getOutputParamDisplayCurrentStep(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the displayName value of the given output parameter from the current step scope

Specified by:

getOutputParamDisplayCurrentStep in interface DiagContextExtn

Parameters:

pParamName - name of the output parameter

Returns:

value of the output parameter displayName

getOutputParamCurrentExecForStep

public java.lang.Object getOutputParamCurrentExecForStep(java.lang.String pStepName,
                                                         java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Gets the value of the given output parameter from the given step within the current execution scope.

Specified by:

getOutputParamCurrentExecForStep in interface DiagContextExtn

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.

addOutputParam

public void addOutputParam(java.lang.String pExecId,
                           java.lang.String pStepName,
                           java.lang.String pParamName,
                           java.lang.Object pParamValue)

Description copied from interface: DiagContextExtn

Adds the given output paramter at the given execution and step scope.

Specified by:

addOutputParam in interface DiagContextExtn

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

addOutputParamDisplay

public void addOutputParamDisplay(java.lang.String pExecId,
                                  java.lang.String pStepName,
                                  java.lang.String pParamName,
                                  java.lang.String pParamDisplayName)

keys

public java.util.List<java.lang.String> keys(java.lang.String pScope)

Description copied from interface: DiagContextExtn

Returns the keys for all the entities within the given scope

Specified by:

keys in interface DiagContextExtn

Parameters:

pScope - name of the scope

Returns:

the keys for all the entities within the given scope

getInputParamNames

public java.util.List<java.lang.String> getInputParamNames()

Description copied from interface: DiagContext

Returns the list of names of input parameters that are available for the current test step.

Specified by:

getInputParamNames in interface DiagContext

Returns:

the list of names of input parameters that are available for the current test step.

getInputParamDef

public TestParam getInputParamDef(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Returns the definition for the input parameter with the given name

Specified by:

getInputParamDef in interface DiagContextExtn

Parameters:

pParamName - name of parameter

Returns:

the definition for the input parameter with the given name, null if no such parameter found

getOutputParamDef

public TestParam getOutputParamDef(java.lang.String pParamName)

Description copied from interface: DiagContextExtn

Returns the definition for the output parameter with the given name

Specified by:

getOutputParamDef in interface DiagContextExtn

Parameters:

pParamName - name of parameter

Returns:

the definition for the output parameter with the given name, null if no such parameter found

getInputParamNamesTest

public java.util.List<java.lang.String> getInputParamNamesTest()

Description copied from interface: DiagContextExtn

Returns the list of input parameter names at the test scope

Specified by:

getInputParamNamesTest in interface DiagContextExtn

Returns:

the list of input parameter names at the test scope

getInputParamNamesCurrentExec

public java.util.List<java.lang.String> getInputParamNamesCurrentExec()

Description copied from interface: DiagContextExtn

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

Specified by:

getInputParamNamesCurrentExec in interface DiagContextExtn

Returns:

the list of input parameter names at the current execution scope

getOutputParamNamesCurrentExec

public java.util.List<java.lang.String> getOutputParamNamesCurrentExec()

Description copied from interface: DiagContextExtn

Returns the list of output parameter names at the current execution scope

Specified by:

getOutputParamNamesCurrentExec in interface DiagContextExtn

Returns:

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

getInputParamNamesCurrentStep

public java.util.List<java.lang.String> getInputParamNamesCurrentStep()

Description copied from interface: DiagContextExtn

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

Specified by:

getInputParamNamesCurrentStep in interface DiagContextExtn

Returns:

the list of input parameter names at the current step scope

getOutputParamNamesCurrentStep

public java.util.List<java.lang.String> getOutputParamNamesCurrentStep()

Description copied from interface: DiagContextExtn

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

Specified by:

getOutputParamNamesCurrentStep in interface DiagContextExtn

Returns:

the list of output parameter names at the current step scope

getCurrentStepScope

public java.lang.Object getCurrentStepScope(java.lang.String pKey)

Description copied from interface: DiagContextExtn

Gets the object with the given key from the current execution and current step scope.

Specified by:

getCurrentStepScope in interface DiagContextExtn

Parameters:

pKey - key for the object to retrieve

Returns:

the object with the given key retrieved from the current execution and current step scope.

putCurrentStepScope

public void putCurrentStepScope(java.lang.String pKey,
                                java.lang.Object pValue)

Description copied from interface: DiagContextExtn

Puts the given object with the given key under the current execution and current step scope.

Specified by:

putCurrentStepScope in interface DiagContextExtn

Parameters:

pKey - key for the object

pValue - the object to store in the context

removeCurrentStepScope

public void removeCurrentStepScope(java.lang.String pKey)

Description copied from interface: DiagContextExtn

Removes the object with the given key from the current execution and current step scope.

Specified by:

removeCurrentStepScope in interface DiagContextExtn

Parameters:

pKey - key for the object to remove

getCurrentParentStepName

public java.lang.String getCurrentParentStepName()

Description copied from interface: DiagContextExtn

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

Specified by:

getCurrentParentStepName in interface DiagContextExtn

Returns:

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

popParentStepName

public java.lang.String popParentStepName()

Description copied from interface: DiagContextExtn

Pops the current parent step name from the stack of parent step names.

Specified by:

popParentStepName in interface DiagContextExtn

Returns:

the popped parent step name.

pushParentStepName

public void pushParentStepName(java.lang.String pParentStepName)

Description copied from interface: DiagContextExtn

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.

Specified by:

pushParentStepName in interface DiagContextExtn

Parameters:

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

getStepReportExtn

public StepReportExtn getStepReportExtn()

Description copied from interface: DiagContextExtn

Returns the internal interface to the current step report from the context.

Specified by:

getStepReportExtn in interface DiagContextExtn

Returns:

the current step report.