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

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl<TestParam>
      oracle.apps.fnd.appltest.diagfwk.engine.impl.TestParamImpl

All Implemented Interfaces:

DiagConstants, DiagBObj<TestParam>, TestParam

public class TestParamImpl
extends DiagBObjImpl<TestParam>
implements TestParam

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/TestParamImpl.java /main/16 2010/11/29 15:21:53 lwong Exp $

Author:

ppradhan

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.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

TestParamImpl()

Method Summary

void	copy(TestParam pObj) Copies contents of the given test parameter object into the current object
void	copyT(java.lang.Object pObj) Copies the contents of the given object into this object
java.lang.String	getActiveFlag() Returns the active flag for the parameter
java.lang.String	getDefaultValue() Returns the default value for the parameter.
java.lang.String	getDescription() Returns the description for the parameter
java.lang.String	getDisplayName() Returns the display name for the parameter
DiagInputValidator	getInputValidator() Returns the input validator class for this parameter if one exists.
java.lang.String	getInputValidatorClassName() Returns the name of the Validator class for this parameter if applicable.
java.lang.String	getIOFlag() Returns the I/O type to indicate whether this parameter is input or output parameter
protected static java.lang.String	getIOFlag(ParameterDefType p) Gets the IO flag based on whether the given parameter definition (JAXB) is of input or output type
boolean	getIsSecure() Returns the is secure flag for the parameter.
java.lang.String	getLOVColumnHeader(LOVColumn pColumn) Returns the translated LOV Column Header for the given LOV Column based on the metadata provided by this parameter's LOVProvider.
java.util.List	getLOVData(java.lang.Object pCurrentValue) Invokes the LOV Handler for this parameter (if applicable) and returns the data contents for the LOV.
java.util.List	getLOVData(java.lang.Object pCurrentValue, FilterOperator pCurrentValueFO) Invokes the LOV Handler for this parameter (if applicable) and returns the data contents for the LOV.
DiagLOVProvider	getLOVProvider() Returns the LOV Provider class for this parameter if one exists.
java.lang.String	getLOVProviderClassName() Returns the name of the LOV Provider Class for this parameter if applicable.
LOVColumn	getLOVValueColumn() Returns the LOV's Value Column if a LOVProvider is defined for this parameter.
java.lang.String	getLOVValueColumnHeader() Returns the translated LOV Column Header for the value column for this parameter's LOVProvider.
java.lang.String	getParamName() Returns the parameter name
boolean	getRequired() Returns the required flag for the parameter.
java.lang.String	getTestExtnName() Gets the extension name for the test to this which this parameter belongs.
java.lang.String	getTestId() Returns the test ID
java.lang.String	getType() Returns the data type for the parameter.
boolean	hasInputValidator() Returns a boolean flag to indicate whether this parameter has a Validator
boolean	hasLOVProvider() Returns a boolean flag to indicate whether this parameter has a LOV Provider.
boolean	hasParameterDefMetadata() Checks to see if the parameter definition metadata exists for this parameter.
void	invokeInputValidation(java.lang.Object pCurrentValue) Invokes the Validator for this parameter (if applicable) using the given current value for the parameter.
void	setActiveFlag(java.lang.String pActiveFlag) Sets the "Active" flag
void	setDefaultValue(java.lang.String pDefaultValue) Sets the default value for this parameter
void	setDescription(java.lang.String pDescription) Sets the description
void	setDisplayName(java.lang.String pDisplayName) Sets the display name for the parameter
void	setIOFlag(java.lang.String pIOType) Sets the IO type
void	setParameterDefType(ParameterDefType p) Sets the corresponding JAXB representation of this parameter
void	setParamName(java.lang.String pParamName) Sets the parameter name
void	setTestExtnName(java.lang.String pTestExtnName) Sets the extension name for the test to this which this parameter belongs.
void	setTestId(java.lang.String pTestId) Sets the test ID

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

TestParamImpl

public TestParamImpl()

Method Detail

getTestId

public java.lang.String getTestId()

Description copied from interface: TestParam

Returns the test ID

Specified by:

getTestId in interface TestParam

Returns:

the test ID

getParamName

public java.lang.String getParamName()

Description copied from interface: TestParam

Returns the parameter name

Specified by:

getParamName in interface TestParam

Returns:

the parameter name

getIOFlag

public java.lang.String getIOFlag()

Description copied from interface: TestParam

Returns the I/O type to indicate whether this parameter is input or output parameter

Specified by:

getIOFlag in interface TestParam

Returns:

'I' if this parameter is an input parameter; 'O' if this parameter is an output parameter.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: TestParam

Returns the display name for the parameter

Specified by:

getDisplayName in interface TestParam

Returns:

the display name for the parameter

getDescription

public java.lang.String getDescription()

Description copied from interface: TestParam

Returns the description for the parameter

Specified by:

getDescription in interface TestParam

Returns:

the description for the parameter

getRequired

public boolean getRequired()

Description copied from interface: TestParam

Returns the required flag for the parameter. As this method returns this value from the parameter definition metadata it is advisable to first check if the metadata exists by calling hasParameterDefMetadata() prior to calling this method.

Specified by:

getRequired in interface TestParam

Returns:

the required flag for the parameter

getIsSecure

public boolean getIsSecure()

Description copied from interface: TestParam

Returns the is secure flag for the parameter. As this method returns this value from the parameter definition metadata it is advisable to first check if the metadata exists by calling hasParameterDefMetadata() prior to calling this method.

Specified by:

getIsSecure in interface TestParam

Returns:

the is secure flag for the parameter

getType

public java.lang.String getType()

Description copied from interface: TestParam

Returns the data type for the parameter. As this method returns this value from the parameter definition metadata it is advisable to first check if the metadata exists by calling hasParameterDefMetadata() prior to calling this method.

Specified by:

getType in interface TestParam

Returns:

the data type for the parameter

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: TestParam

Returns the default value for the parameter. As this method returns this value from the parameter definition metadata it is advisable to first check if the metadata exists by calling hasParameterDefMetadata() prior to calling this method.

Specified by:

getDefaultValue in interface TestParam

Returns:

the default value for the parameter

getActiveFlag

public java.lang.String getActiveFlag()

Description copied from interface: TestParam

Returns the active flag for the parameter

Specified by:

getActiveFlag in interface TestParam

Returns:

the active flag for the parameter

setTestId

public void setTestId(java.lang.String pTestId)

Description copied from interface: TestParam

Sets the test ID

Specified by:

setTestId in interface TestParam

Parameters:

pTestId - the test id

setParamName

public void setParamName(java.lang.String pParamName)

Description copied from interface: TestParam

Sets the parameter name

Specified by:

setParamName in interface TestParam

Parameters:

pParamName - the parameter name

setIOFlag

public void setIOFlag(java.lang.String pIOType)

Description copied from interface: TestParam

Sets the IO type

Specified by:

setIOFlag in interface TestParam

Parameters:

pIOType - the IO type

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Description copied from interface: TestParam

Sets the display name for the parameter

Specified by:

setDisplayName in interface TestParam

Parameters:

pDisplayName - the display name for the parameter

setDescription

public void setDescription(java.lang.String pDescription)

Description copied from interface: TestParam

Sets the description

Specified by:

setDescription in interface TestParam

Parameters:

pDescription - the description

setParameterDefType

public void setParameterDefType(ParameterDefType p)

Description copied from interface: TestParam

Sets the corresponding JAXB representation of this parameter

Specified by:

setParameterDefType in interface TestParam

Parameters:

p - JAXB object that represents this parameter

hasParameterDefMetadata

public boolean hasParameterDefMetadata()

Description copied from interface: TestParam

Checks to see if the parameter definition metadata exists for this parameter. It performs this check by checking if the ParameterDefType has been set for this parameter.

Specified by:

hasParameterDefMetadata in interface TestParam

Returns:

true if the parameter metadata is available. returns false otherwise.

setActiveFlag

public void setActiveFlag(java.lang.String pActiveFlag)

Description copied from interface: TestParam

Sets the "Active" flag

Specified by:

setActiveFlag in interface TestParam

Parameters:

pActiveFlag - the "Active" flag

getIOFlag

protected static java.lang.String getIOFlag(ParameterDefType p)

Gets the IO flag based on whether the given parameter definition (JAXB) is of input or output type

Parameters:

p -

Returns:

copy

public void copy(TestParam pObj)

Description copied from interface: TestParam

Copies contents of the given test parameter object into the current object

Specified by:

copy in interface TestParam

Specified by:

copy in class DiagBObjImpl<TestParam>

Parameters:

pObj - source test parameter object to copy from.

copyT

public void copyT(java.lang.Object pObj)

Description copied from interface: DiagBObj

Copies the contents of the given object into this object

Specified by:

copyT in interface DiagBObj<TestParam>

Parameters:

pObj - the contents of the given object into this object

setDefaultValue

public void setDefaultValue(java.lang.String pDefaultValue)

Description copied from interface: TestParam

Sets the default value for this parameter

Specified by:

setDefaultValue in interface TestParam

Parameters:

pDefaultValue - the default value for this parameter

getLOVProviderClassName

public java.lang.String getLOVProviderClassName()

Description copied from interface: TestParam

Returns the name of the LOV Provider Class for this parameter if applicable. A LOV Provider maybe available if the parameter is an input parameter.

Specified by:

getLOVProviderClassName in interface TestParam

Returns:

the name of the LOV Provider Class if one exists. Otherwise returns null.

getInputValidatorClassName

public java.lang.String getInputValidatorClassName()

Description copied from interface: TestParam

Returns the name of the Validator class for this parameter if applicable. A Validator class may be available for this parameter if it is an input parameter.

Specified by:

getInputValidatorClassName in interface TestParam

Returns:

the name of the Validator class if one exists. Otherwise returns null.

hasLOVProvider

public boolean hasLOVProvider()

Description copied from interface: TestParam

Returns a boolean flag to indicate whether this parameter has a LOV Provider.

Specified by:

hasLOVProvider in interface TestParam

Returns:

true if a LOV Provider exists for this parameter. false otherwise.

hasInputValidator

public boolean hasInputValidator()

Description copied from interface: TestParam

Returns a boolean flag to indicate whether this parameter has a Validator

Specified by:

hasInputValidator in interface TestParam

Returns:

true if a Validator exists for this parameter. returns false otherwise.

getLOVProvider

public DiagLOVProvider getLOVProvider()

Description copied from interface: TestParam

Returns the LOV Provider class for this parameter if one exists. Otherwise returns null.

Specified by:

getLOVProvider in interface TestParam

Returns:

the LOV Provider class for this parameter if one exists. Otherwise returns null.

getInputValidator

public DiagInputValidator getInputValidator()

Description copied from interface: TestParam

Returns the input validator class for this parameter if one exists. Otherwise returns null.

Specified by:

getInputValidator in interface TestParam

Returns:

the input validator class for this parameter if one exists. Otherwise returns null.

getLOVData

public java.util.List getLOVData(java.lang.Object pCurrentValue)

Description copied from interface: TestParam

Invokes the LOV Handler for this parameter (if applicable) and returns the data contents for the LOV. Prepares the input parameter context prior to invoking the LOV Handler and uses the current parameter name and the given value for the parameter to populate the input parameter context.

Specified by:

getLOVData in interface TestParam

Parameters:

pCurrentValue - current value for the value column

Returns:

the List returned by the DiagLOVHandler.getData() method.

getLOVData

public java.util.List getLOVData(java.lang.Object pCurrentValue,
                                 FilterOperator pCurrentValueFO)

Description copied from interface: TestParam

Invokes the LOV Handler for this parameter (if applicable) and returns the data contents for the LOV. Prepares the input parameter context prior to invoking the LOV Handler and uses the current parameter name and the given value for the parameter to populate the input parameter context.

Specified by:

getLOVData in interface TestParam

Parameters:

pCurrentValue - current value for the value column

pCurrentValueFO - current filter operator for the value column

Returns:

the List returned by the DiagLOVHandler.getData() method.

invokeInputValidation

public void invokeInputValidation(java.lang.Object pCurrentValue)
                           throws InputValidationException

Description copied from interface: TestParam

Invokes the Validator for this parameter (if applicable) using the given current value for the parameter.

If a validator is defined, the validator is invoked. Otherwise this method will check if a LOVProvider is defined. If yes, it will verify if the given value exists within the data returned by the LOV Provider.

Validator and LOVProvider classes are loaded using the extension classes loading mechanism. Hence callers can optionally also choose to call setTestExtnName() method prior to calling this method in order to specify the extension name to load the classes from. If the testExtnName attribute is not set at the time of calling this method, any Validator and LOVProvider classes will be loaded by looking at all extensions properties files specified in the extension directory.

Specified by:

invokeInputValidation in interface TestParam

Parameters:

pCurrentValue - current value for the parameter to be validated.

Throws:

InputValidationException - when any validation errors occur.

getLOVColumnHeader

public java.lang.String getLOVColumnHeader(LOVColumn pColumn)

Description copied from interface: TestParam

Returns the translated LOV Column Header for the given LOV Column based on the metadata provided by this parameter's LOVProvider. If this parameter does not specify a LOVProvider then this method returns null.

Specified by:

getLOVColumnHeader in interface TestParam

Parameters:

pColumn - The LOVColumn that represents a particular column in the LOV for this parameter

Returns:

the translated LOV Column Header for the specified column.

getLOVValueColumnHeader

public java.lang.String getLOVValueColumnHeader()

Description copied from interface: TestParam

Returns the translated LOV Column Header for the value column for this parameter's LOVProvider. If this parameter does not specify a LOV Provider then this method returns null.

Specified by:

getLOVValueColumnHeader in interface TestParam

Returns:

the translated LOV Column Header for the value column for the LOV for this parameter if a LOVProvider is defined. Returns null if LOVProvider is not defined.

getLOVValueColumn

public LOVColumn getLOVValueColumn()

Description copied from interface: TestParam

Returns the LOV's Value Column if a LOVProvider is defined for this parameter. Otherwise returns null.

Specified by:

getLOVValueColumn in interface TestParam

Returns:

the LOV's Value Column if a LOVProvider is defined for this parameter. Otherwise returns null.

setTestExtnName

public void setTestExtnName(java.lang.String pTestExtnName)

Description copied from interface: TestParam

Sets the extension name for the test to this which this parameter belongs. This attribute is used when invokeInputValidation() method is called on this parameter for loading any associated LOV Provider or Validator classes.

Specified by:

setTestExtnName in interface TestParam

Parameters:

pTestExtnName - extension name for the test to which this parameter belongs.

getTestExtnName

public java.lang.String getTestExtnName()

Description copied from interface: TestParam

Gets the extension name for the test to this which this parameter belongs. This attribute is used when invokeInputValidation() method is called on this parameter for loading any associated LOV Provider or Validator classes.

Specified by:

getTestExtnName in interface TestParam

Returns:

extension name for the test to which this parameter belongs.