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

All Superinterfaces:

DiagBObj<TestParam>, DiagConstants

All Known Implementing Classes:

TestParamImpl

public interface TestParam
extends DiagBObj<TestParam>

Models a test parameter. A parameter can either be an input parameter or an output parameter.

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

Method Summary

void	copy(TestParam p) Copies contents of the given test parameter object into the current 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
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 interface oracle.apps.fnd.appltest.diagfwk.engine.DiagBObj

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

Method Detail

getTestId

java.lang.String getTestId()

Returns the test ID

Returns:

the test ID

getParamName

java.lang.String getParamName()

Returns the parameter name

Returns:

the parameter name

getIOFlag

java.lang.String getIOFlag()

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

Returns:

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

getDisplayName

java.lang.String getDisplayName()

Returns the display name for the parameter

Returns:

the display name for the parameter

getDescription

java.lang.String getDescription()

Returns the description for the parameter

Returns:

the description for the parameter

getRequired

boolean getRequired()

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.

Returns:

the required flag for the parameter

getIsSecure

boolean getIsSecure()

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.

Returns:

the is secure flag for the parameter

getType

java.lang.String getType()

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.

Returns:

the data type for the parameter

getDefaultValue

java.lang.String getDefaultValue()

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.

Returns:

the default value for the parameter

getActiveFlag

java.lang.String getActiveFlag()

Returns the active flag for the parameter

Returns:

the active flag for the parameter

setTestId

void setTestId(java.lang.String pTestId)

Sets the test ID

Parameters:

pTestId - the test id

setParamName

void setParamName(java.lang.String pParamName)

Sets the parameter name

Parameters:

pParamName - the parameter name

setIOFlag

void setIOFlag(java.lang.String pIOType)

Sets the IO type

Parameters:

pIOType - the IO type

setDisplayName

void setDisplayName(java.lang.String pDisplayName)

Sets the display name for the parameter

Parameters:

pDisplayName - the display name for the parameter

setDescription

void setDescription(java.lang.String pDescription)

Sets the description

Parameters:

pDescription - the description

setParameterDefType

void setParameterDefType(ParameterDefType p)

Sets the corresponding JAXB representation of this parameter

Parameters:

p - JAXB object that represents this parameter

hasParameterDefMetadata

boolean hasParameterDefMetadata()

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.

Returns:

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

copy

void copy(TestParam p)

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

Parameters:

p - source test parameter object to copy from.

setDefaultValue

void setDefaultValue(java.lang.String pDefaultValue)

Sets the default value for this parameter

Parameters:

pDefaultValue - the default value for this parameter

setActiveFlag

void setActiveFlag(java.lang.String pActiveFlag)

Sets the "Active" flag

Parameters:

pActiveFlag - the "Active" flag

setTestExtnName

void setTestExtnName(java.lang.String pTestExtnName)

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.

Parameters:

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

getLOVProviderClassName

java.lang.String getLOVProviderClassName()

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.

Returns:

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

getInputValidatorClassName

java.lang.String getInputValidatorClassName()

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.

Returns:

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

hasLOVProvider

boolean hasLOVProvider()

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

Returns:

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

hasInputValidator

boolean hasInputValidator()

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

Returns:

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

getLOVProvider

DiagLOVProvider getLOVProvider()

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

Returns:

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

getInputValidator

DiagInputValidator getInputValidator()

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

Returns:

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

getLOVData

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

Parameters:

pCurrentValue - current value for the value column

Returns:

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

getLOVData

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

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

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

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.

Parameters:

pCurrentValue - current value for the parameter to be validated.

Throws:

InputValidationException - when any validation errors occur.

getLOVColumnHeader

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. If this parameter does not specify a LOVProvider then this method returns null.

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

java.lang.String getLOVValueColumnHeader()

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.

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

LOVColumn getLOVValueColumn()

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

Returns:

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

getTestExtnName

java.lang.String getTestExtnName()

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.

Returns:

extension name for the test to which this parameter belongs.