|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface 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 |
---|
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 |
---|
java.lang.String getTestId()
java.lang.String getParamName()
java.lang.String getIOFlag()
java.lang.String getDisplayName()
java.lang.String getDescription()
boolean getRequired()
boolean getIsSecure()
java.lang.String getType()
java.lang.String getDefaultValue()
java.lang.String getActiveFlag()
void setTestId(java.lang.String pTestId)
pTestId
- the test idvoid setParamName(java.lang.String pParamName)
pParamName
- the parameter namevoid setIOFlag(java.lang.String pIOType)
pIOType
- the IO typevoid setDisplayName(java.lang.String pDisplayName)
pDisplayName
- the display name for the parametervoid setDescription(java.lang.String pDescription)
pDescription
- the descriptionvoid setParameterDefType(ParameterDefType p)
p
- JAXB object that represents this parameterboolean hasParameterDefMetadata()
void copy(TestParam p)
p
- source test parameter object to copy from.void setDefaultValue(java.lang.String pDefaultValue)
pDefaultValue
- the default value for this parametervoid setActiveFlag(java.lang.String pActiveFlag)
pActiveFlag
- the "Active" flagvoid setTestExtnName(java.lang.String pTestExtnName)
pTestExtnName
- extension name for the test to which this
parameter belongs.java.lang.String getLOVProviderClassName()
java.lang.String getInputValidatorClassName()
boolean hasLOVProvider()
boolean hasInputValidator()
DiagLOVProvider getLOVProvider()
DiagInputValidator getInputValidator()
java.util.List getLOVData(java.lang.Object pCurrentValue)
pCurrentValue
- current value for the value column
java.util.List getLOVData(java.lang.Object pCurrentValue, FilterOperator pCurrentValueFO)
pCurrentValue
- current value for the value columnpCurrentValueFO
- current filter operator for the value column
void invokeInputValidation(java.lang.Object pCurrentValue) throws InputValidationException
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.
pCurrentValue
- current value for the parameter to
be validated.
InputValidationException
- when any validation
errors occur.java.lang.String getLOVColumnHeader(LOVColumn pColumn)
pColumn
- The LOVColumn that represents a
particular column in the LOV for this parameter
java.lang.String getLOVValueColumnHeader()
LOVColumn getLOVValueColumn()
java.lang.String getTestExtnName()
|
Oracle Fusion Middleware extensions for Logging and Diagnostic 11g Release 1 (11.1.1.6) E22565-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |