|
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 TestDef
Models the test definition business object.
This interface encapsulates all the operations for a single test definition.
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 | |
---|---|
TestTreeNode |
asTestTreeNode()
Returns this test definition object as a TestTreeNode instance |
void |
copy(TestDef pObj)
Copies the contents of the given object into this object |
void |
copyAndPopulate(TestDef pObj)
Copies the contents of the given object into this object After copying the TestDef attribtues, the JAXB Tree is populated based on the test metadata. |
boolean |
delete()
deletes the test and it's associated data from the db deletes parms, inputsets unlinks the tag values, and prereqs from this test |
void |
fetch()
Fetches the test definition from the repository for this test. |
java.util.List<TestParam> |
fetchActiveInputParams()
Fetches the list of active input parameters for this test. |
java.util.List<TestParam> |
fetchActiveOutputParams()
Fetches the list of active output parameters for this test. |
TestInputSetList |
fetchDefaultInputSetList()
Fetches the list of default input sets for this test |
java.util.List<TestParam> |
fetchInputParams()
Fetches the test input parameters metadata from this test. |
TestInputSetList |
fetchInputSetList()
Fetches the list of input sets for this test. |
java.util.List<TestParam> |
fetchOutputParams()
Fetches the test output parameters metadata from this test. |
void |
fetchSummary()
Fetches the test definition summary information only from the repository for this test. |
java.util.List<java.lang.String> |
getAllPrereqTestIds()
Returns the list of all the prerequisite Test IDs for this test. |
java.lang.String |
getDateFormat()
Get the date format string that be used to encode date parameters |
java.lang.String |
getDescription()
Returns the description |
java.lang.String |
getDisplayName()
Returns the display name |
java.lang.Boolean |
getExecuteAllowed()
|
java.lang.String |
getExtnName()
Returns the extension name of this test from the test metadata |
TestParamList |
getInputParamList()
Returns the list of input parameters for this test. |
TestInputSetList |
getInputSetList()
Gets the input set list for this test |
java.lang.String |
getInputsStatus()
Gets the inputs status code for this test. |
java.lang.String |
getModuleId()
Returns the module ID for the taxonomy module that owns the seed data for this test. |
java.lang.String |
getModuleName()
Returns the module Name for the taxonomy module that owns the seed data for this test. |
int |
getObjectVersionNumber()
Returns the current object version number |
TestParamList |
getOutputParamList()
Returns the list of output parameters for this test. |
TestPrereqList |
getPrereqs()
Returns the list of prerequisite tests or tag values associated with this test. |
int |
getPrereqTestCount()
Gets the prerequisite test count for this test. |
java.util.List<java.lang.String> |
getPrereqTestIdsForIncludes()
Returns only the list of prerequisite Test IDs for any tests that are included in this test (via nested test reference steps). |
java.lang.String |
getRequiresApplicationCode()
Returns the flag indicating whether the diagnostic test will need to access code from within the fusion application. |
java.lang.String |
getSensitivity()
Gets the sensitivity for the test. |
TagValueList |
getTagValueList()
Returns the list of tags values associated with this test. |
java.lang.String |
getTestId()
Gets the Test ID |
java.lang.String |
getTestMetadata()
Returns the test metadata XML. |
java.lang.String |
getTestName()
Gets the Test Name |
java.lang.String |
getTestType()
Gets the test type e.g. |
java.lang.String |
getUsage()
Returns the usage |
java.lang.String |
getVersion()
Returns the version of this test from the test metadata |
java.lang.Boolean |
getViewReportAllowed()
|
boolean |
hasRequiredInputParams()
This API checks to see if the test has any required input parameters declared in its metadata. |
void |
populate(java.lang.String pXMLMetadata)
Populates this object based on the given Test Definition XML metadata String. |
void |
populateFromClass(java.lang.String pJavaClassName)
Populates this object based on the given Test class file. |
void |
populateFromFile(java.lang.String pFilePath)
Populates this object based on the given Test file. |
void |
populateTestAvailabilityInfo(TestAvailabilityInfo info)
Checks the steps of this test, populates test availability information and recursively gathers availability information of nested tests. |
java.util.List<TestPrereq> |
queryActivePrereqTests(java.lang.String pTestName)
Queries the list of active prerequisites for the given test |
java.util.List<TagValue> |
queryActiveTagValues(java.lang.String pTestName)
Queries the list of active tag values for the given test |
void |
removeTagValueIdReference(java.lang.String pTagValueId,
boolean pAssocOnly)
Removes the reference to the given tag value ID from this test's definition metadata. |
TestExec |
run(DiagContextExtn pContext)
Runs the diagnostic test for this test definition based on the information available in the context. |
void |
save()
Saves the in-memory test definition in this object into the test repository. |
void |
saveErrorTestExec(TestRun run,
NameValueList inputs,
oracle.apps.fnd.appllcm.sdk.common.ResourceRef pErrMsg,
java.lang.Throwable t)
Saves a new TestExecution after logging the given exception in it. |
void |
setDescription(java.lang.String pDescription)
Sets the description. |
void |
setDisplayName(java.lang.String pDisplayName)
Sets the test display name. |
void |
setExecuteAllowed(java.lang.Boolean pExecuteAllowed)
|
void |
setExtnName(java.lang.String pExtnName)
Sets the ExtnName |
void |
setInputParamList(TestParamList p)
Sets the input parameter list for this test definition. |
void |
setInputSetList(TestInputSetList inputSetList)
Sets the input set list for this test. |
void |
setInputsStatus(java.lang.String inputsStatus)
Sets the inputs status code for this test |
void |
setModuleId(java.lang.String pModuleId)
Sets the module ID |
void |
setModuleName(java.lang.String pModuleName)
Sets the module Name |
void |
setObjectVersionNumber(int pObjectVersionNumber)
Sets the Object version number. |
void |
setOutputParamList(TestParamList p)
Sets the output parameter list for this test definition. |
void |
setPrereqs(TestPrereqList l)
Sets the test prerequisite list for this test definition. |
void |
setPrereqTestCount(int prereqTestCount)
Sets the prerequisite test count for this test |
void |
setRequiresApplicationCode(java.lang.String pRequiresApplicationCode)
Sets the requiresApplicationCode flag ("Y" or "N") |
void |
setSensitivity(java.lang.String pSensitivity)
Sets the sensitvity. |
void |
setTagValueList(TagValueList l)
Sets the tag value list for this test definition |
void |
setTestId(java.lang.String pTestId)
Sets the test ID. |
void |
setTestMetadata(java.lang.String pTestMetadata)
Sets the test metadata XML. |
void |
setTestName(java.lang.String pTestName)
Sets the test name. |
void |
setTestType(java.lang.String pTestType)
Sets the test type. |
void |
setUsage(java.lang.String pUsage)
Sets the usage. |
void |
setViewReportAllowed(java.lang.Boolean pViewReportAllowed)
|
void |
validateInputValues(NameValueList pParamList)
Validates the given list of input values for this test against the test's input parameter metadata for data type consistency. |
void |
validatePreRun()
Performs validations required prior to execution of tests. |
void |
validatePreSave()
Performs all the validation that the save() API would have performed prior to saving the test definition to the repository. |
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 getTestName()
java.lang.String getTestType()
java.lang.String getSensitivity()
java.lang.String getTestMetadata()
int getObjectVersionNumber()
int getPrereqTestCount()
0 - No Prerequisites directly associated with this test
n - Has one or more prerequisites defined (where n is a number greater than 0)
java.lang.String getInputsStatus()
The status code describes the state of whether or not the current test has required inputs. Possible values are:
java.lang.String getDisplayName()
java.lang.String getDescription()
java.lang.String getUsage()
java.lang.String getVersion()
java.lang.String getModuleId()
java.lang.String getModuleName()
java.lang.String getExtnName()
java.lang.String getRequiresApplicationCode()
void setTestId(java.lang.String pTestId)
pTestId
- the test IDvoid setTestName(java.lang.String pTestName)
pTestName
- the test namevoid setTestType(java.lang.String pTestType)
pTestType
- the test typevoid setSensitivity(java.lang.String pSensitivity)
pSensitivity
- the sensitivityvoid setTestMetadata(java.lang.String pTestMetadata)
pTestMetadata
- the test metadata XMLvoid setObjectVersionNumber(int pObjectVersionNumber)
pObjectVersionNumber
- the object version numbervoid setPrereqTestCount(int prereqTestCount)
prereqTestCount
- the prerequisite test count
for this test.void setInputsStatus(java.lang.String inputsStatus)
inputsStatus
- the inputs status code for this
test.void setDisplayName(java.lang.String pDisplayName)
pDisplayName
- the display namevoid setDescription(java.lang.String pDescription)
pDescription
- the descriptionvoid setUsage(java.lang.String pUsage)
pUsage
- the usagevoid setModuleId(java.lang.String pModuleId)
pModuleId
- the module IDvoid setModuleName(java.lang.String pModuleName)
pModuleName
- the module namevoid setExtnName(java.lang.String pExtnName)
pExtnName
- the extension namevoid setRequiresApplicationCode(java.lang.String pRequiresApplicationCode)
pRequiresApplicationCode
- the flagjava.lang.Boolean getExecuteAllowed()
void setExecuteAllowed(java.lang.Boolean pExecuteAllowed)
pExecuteAllowed
- new value of whether execution is allowedjava.lang.Boolean getViewReportAllowed()
void setViewReportAllowed(java.lang.Boolean pViewReportAllowed)
pViewReportAllowed
- new value of whether a test's execution report can
be viewedTestParamList getInputParamList()
TestParamList getOutputParamList()
TagValueList getTagValueList()
TestPrereqList getPrereqs()
void setInputParamList(TestParamList p)
p
- input parameter list for this test definitionvoid setOutputParamList(TestParamList p)
p
- output parameter list for this test definitionvoid setTagValueList(TagValueList l)
l
- tag value list for this test definitionvoid setPrereqs(TestPrereqList l)
l
- test prerequisite list for this test definitionvoid save()
void validatePreSave() throws DiagfwkException
DiagfwkException
- when any validation failure
occurs.void populate(java.lang.String pXMLMetadata)
pXMLMetadata
- Test Definition XML metadatavoid populateFromFile(java.lang.String pFilePath)
pFilePath
- file path for the test file containing
the test metadata definition.void populateFromClass(java.lang.String pJavaClassName)
pJavaClassName
- name of the Java test class.void fetch()
void fetchSummary()
java.util.List<TestParam> fetchInputParams()
java.util.List<TestParam> fetchActiveInputParams()
java.util.List<TestParam> fetchOutputParams()
java.util.List<TestParam> fetchActiveOutputParams()
boolean hasRequiredInputParams()
void copy(TestDef pObj)
pObj
- the object to copy into this object.void copyAndPopulate(TestDef pObj)
pObj
- object to copy into this object.void validatePreRun()
TestExec run(DiagContextExtn pContext)
Status updates are made to the fnd_diag_execution in the test repository periodically using a monitor thread. Additionally, for any test reference steps in this test, new child test executions are spawned.
pContext
- context for the test execution
java.util.List<java.lang.String> getAllPrereqTestIds()
java.util.List<java.lang.String> getPrereqTestIdsForIncludes()
void validateInputValues(NameValueList pParamList) throws DiagfwkException
pParamList
- list of input parameter values to
validate for this test.
DiagfwkException
- when an invalid value is encountered
for a particular input parameter.java.util.List<TestPrereq> queryActivePrereqTests(java.lang.String pTestName)
pTestName
- name of the test
java.util.List<TagValue> queryActiveTagValues(java.lang.String pTestName)
pTestName
- name of the test
void setInputSetList(TestInputSetList inputSetList)
inputSetList
- the input set list for this testTestInputSetList getInputSetList()
TestInputSetList fetchInputSetList()
TestInputSetList fetchDefaultInputSetList()
TestTreeNode asTestTreeNode()
void removeTagValueIdReference(java.lang.String pTagValueId, boolean pAssocOnly)
Removal is performed in the test definition in memory only (i.e. in this object only). The updated definition in memory is not saved to the test repository.
pTagValueId
- - tag value ID to remove reference of
from this test's metadata.pAssocOnly
- - if true removes only the associations
in tag value list. Otherwise removes the entries from prereq
list as well.java.lang.String getDateFormat()
void saveErrorTestExec(TestRun run, NameValueList inputs, oracle.apps.fnd.appllcm.sdk.common.ResourceRef pErrMsg, java.lang.Throwable t)
Caution: This api will overwrite any existing Test Execution in the DB.
run
- the test run to associate the execution withinputs
- the inputs provided for the test. The execution ID is
picked up from this parameter as an internal input.pErrMsg
- the message for the test execution errort
- the exception that occured during execution of this testvoid populateTestAvailabilityInfo(TestAvailabilityInfo info)
info
- pass-by-reference value object for gathering test
availability informationboolean delete()
|
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 |