oracle.apps.fnd.appltest.diagfwk.engine.provider.dao
Interface TagDAO

All Superinterfaces:

BaseDAO

All Known Implementing Classes:

OADBTagDAO

public interface TagDAO
extends BaseDAO

Models a Data Access Object for retrieving Tag related information.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.provider.dao.BaseDAO

BaseDAO.DBSessionInfo

Method Summary

boolean	exists(java.lang.String pTagName) Checks if this tag exists in the repository.
boolean	exists(java.lang.String pTagName, java.lang.String pTagValue) Checks if this tag value exists in the repository.
boolean	existsTagTypeTagValue(java.lang.String tagValueId, java.lang.String tagType) Queries the repository to check if a tag value with the given tagValueId and tagType exists.
TestPrereqList	fetchAllTagValueIdPrereqs(java.lang.String pTagValueId)
TestPrereqList	fetchAllTagValueIdPrereqs(java.lang.String pTagValueId, boolean pProcessIncludedTests)
java.util.List<java.lang.String>	fetchAllTestIdPrereqs(java.lang.String pTagValueId)
TestPrereqList	fetchAllTestIdPrereqs(java.lang.String pTagValueId, int pOrder, TestPrereqList pTagValuePrereqList, TestPrereqList pIncludedTagValueList, TestPrereqList pIncludedTestList)
java.util.List<java.lang.String>	fetchAllTestIdPrereqs(java.lang.String pTagValueId, java.util.List<java.lang.String> pPrereqTagValueIdList)
java.util.List<java.lang.String>	fetchChildTestIds(java.lang.String pTagValueId, boolean pRecurse)
TagValuePrereqList	fetchImmediateTagValueIdPrereqs(java.lang.String pTagValueId) Returns a list of TagValuePrereq objects that are immediate (top level) prerequisites of the given tag value id.
Tag	fetchTagByName(java.lang.String name) Fetches tag definition for a particular tag using the tag name
TagValue	fetchTagValue(java.lang.String tagName, java.lang.String tagValue) Fetches the tag value definition for a particular tag value using the given tag name and tag value
java.lang.String[]	getModuleIdsForApps(java.lang.String[] pAppCodes)
java.lang.String[]	getModuleIdsForModuleKeys(java.lang.String[] pModuleKeys)
java.lang.String	getTagId(java.lang.String pTagName) Queries the tag ID for the given tag name
java.lang.String	getTagValueId(java.lang.String tagName, java.lang.String tagValue) Queries to see if a native diagnostic tag value with the given tagName and tagValue exists in the repository.
boolean	hasTestReferences(java.lang.String pTagName) Checks to see if one or more diagnostic tests reference the given tag name.
boolean	hasTestReferences(java.lang.String pTagName, java.lang.String pTagValue) Checks to see if one or more diagnostic tests reference the given tag name value pair.
void	remove(java.lang.String pTagName) Removes the given tag from the diagnostics repository.
void	remove(java.lang.String pTagName, java.lang.String pTagValue) Removes the given tag name and value pair from the diagnostics repository.
void	save(Tag pTag) Saves the given tag entity into the diagnostics repository
void	save(TagValue pTagValue) Saves the given tag value entity into the diagnostics repository
void	saveWithinTxn(TagValue pObj, java.sql.Connection pConn) Saves the given tag value entity into the diagnostics repository, but allows for this to be done as part of a different transaction.

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.provider.dao.BaseDAO

createSysGuid, getDBSessionInfo, queryNlsParameters, querySysDate, querySysDate

Method Detail

existsTagTypeTagValue

boolean existsTagTypeTagValue(java.lang.String tagValueId,
                              java.lang.String tagType)

Queries the repository to check if a tag value with the given tagValueId and tagType exists.

Parameters:

tagValueId -

tagType -

Returns:

boolean - checks if tag value of the chosen type exists

getTagValueId

java.lang.String getTagValueId(java.lang.String tagName,
                               java.lang.String tagValue)

Queries to see if a native diagnostic tag value with the given tagName and tagValue exists in the repository. If yes, it returns the corresponding tag value ID. Otherwise returns null.

Parameters:

tagName - - Name of the tag

tagValue - - Value of the tag

Returns:

tag value ID corresponding to the given tag name and tag value.

getTagId

java.lang.String getTagId(java.lang.String pTagName)

Queries the tag ID for the given tag name

Parameters:

pTagName - name of the tag to query

Returns:

the tag ID for the given tag name

fetchImmediateTagValueIdPrereqs

TagValuePrereqList fetchImmediateTagValueIdPrereqs(java.lang.String pTagValueId)

Returns a list of TagValuePrereq objects that are immediate (top level) prerequisites of the given tag value id.

Parameters:

pTagValueId - tag value id for which to fetch the prereqs

Returns:

list of TagValuePrereq objects that are immediate (top level) prerequisites of the given tag value id.

fetchAllTagValueIdPrereqs

TestPrereqList fetchAllTagValueIdPrereqs(java.lang.String pTagValueId)
                                         throws DiagPrereqCycleException

Parameters:

pTagValueId - - Source Tag Value ID for which to find TagValueId Prereq List

Returns:

list of TagValueIdPrereq objects in the expected execution order

Throws:

DiagPrereqCycleException - shows cycle found during dependency resolution process.

fetchAllTagValueIdPrereqs

TestPrereqList fetchAllTagValueIdPrereqs(java.lang.String pTagValueId,
                                         boolean pProcessIncludedTests)
                                         throws DiagPrereqCycleException

Parameters:

pTagValueId - Tag Value Id for which to fetch all Tag Value Prereqs.

pProcessIncludedTests - Flag value true indicates that tag value prereq dependency resolution process will analyze both tag value prereqs and test prereqs.

Returns:

TestPrereqList, which is a List of TagValue Prereqs

Throws:

DiagPrereqCycleException - shows cycle found during dependency resolution process.

fetchAllTestIdPrereqs

java.util.List<java.lang.String> fetchAllTestIdPrereqs(java.lang.String pTagValueId)
                                                       throws DiagPrereqCycleException

Parameters:

pTagValueId - - Source Tag Value ID for which to find TagValueId Prereq List

Returns:

List of Prereq Test Ids - after processing all dependencies

Throws:

DiagPrereqCycleException - shows cycle found during dependency resolution process.

fetchAllTestIdPrereqs

java.util.List<java.lang.String> fetchAllTestIdPrereqs(java.lang.String pTagValueId,
                                                       java.util.List<java.lang.String> pPrereqTagValueIdList)
                                                       throws DiagPrereqCycleException

Parameters:

pTagValueId - - Tag Value Id

pPrereqTagValueIdList - - When value is null, API will not add Prereq Tag Value Ids. When value is not null, API will append Prereq Tag Value Id list, discovered while resolving tag value id dependencies, including child tag value ids of the passed parameter "pTagValueId", but excluding the parameter itself.

Returns:

List of Prereq Test Ids - after processing all dependencies

Throws:

DiagPrereqCycleException - shows cycle found during dependency resolution process.

fetchAllTestIdPrereqs

TestPrereqList fetchAllTestIdPrereqs(java.lang.String pTagValueId,
                                     int pOrder,
                                     TestPrereqList pTagValuePrereqList,
                                     TestPrereqList pIncludedTagValueList,
                                     TestPrereqList pIncludedTestList)
                                     throws DiagPrereqCycleException

Parameters:

pTagValueId - - Tag Value Id

pOrder - - Order number of pTagValueId

pTagValuePrereqList - - When value is null, API will not add TagValue type TestPrereqs. When value is not null, API will append TagValue type TestPrereqs, discovered while resolving tag value id dependencies, excluding the parameter - pTagValueId - itself and its child tag value ids.

pIncludedTagValueList - - When not null, add child Tag Values (as TestPrereqList with order info)

pIncludedTestList - - When not null, add child Tests (as TestPrereqList with order info)

Returns:

Test type TestPrereqList - after processing all dependencies

Throws:

DiagPrereqCycleException - shows cycle found during dependency resolution process.

fetchChildTestIds

java.util.List<java.lang.String> fetchChildTestIds(java.lang.String pTagValueId,
                                                   boolean pRecurse)

Parameters:

pTagValueId - - Child Tag Value ID's

pRecurse - - when true, prerequites are resolved recursively; otherwise, only straight chid nodes are considered.

Returns:

List of Tag Value IDs as List of Strings - after processing all dependencies

getModuleIdsForApps

java.lang.String[] getModuleIdsForApps(java.lang.String[] pAppCodes)

Parameters:

pAppCodes - - Taxonomy Module Keys - Each Module Key has unique Module Id

Returns:

Module Id's as a String []

getModuleIdsForModuleKeys

java.lang.String[] getModuleIdsForModuleKeys(java.lang.String[] pModuleKeys)

Parameters:

pModuleKeys - - Taxonomy Module Keys - Each Module Key has unique Module Id

Returns:

Module Id's as a String []

save

void save(Tag pTag)

Saves the given tag entity into the diagnostics repository

Parameters:

pTag - tag entity to save

save

void save(TagValue pTagValue)

Saves the given tag value entity into the diagnostics repository

Parameters:

pTagValue - tag value entity to save

saveWithinTxn

void saveWithinTxn(TagValue pObj,
                   java.sql.Connection pConn)

Saves the given tag value entity into the diagnostics repository, but allows for this to be done as part of a different transaction.

Parameters:

pObj - tag value entity to save

pConn - the connection to use for saving

remove

void remove(java.lang.String pTagName)

Removes the given tag from the diagnostics repository. Removes all tag values that belong to this tag as well.

Parameters:

pTagName - name of the tag to remove.

remove

void remove(java.lang.String pTagName,
            java.lang.String pTagValue)

Removes the given tag name and value pair from the diagnostics repository. Any tests that reference this tag value are also cleaned up so that they no longer reference this tag value after this operation is complete.

Parameters:

pTagName - name of the tag

pTagValue - value of the tag

hasTestReferences

boolean hasTestReferences(java.lang.String pTagName,
                          java.lang.String pTagValue)

Checks to see if one or more diagnostic tests reference the given tag name value pair. References are either associations (i.e. test is tagged using the given name value pair) or prerequisite (i.e. test prereqs the given tag name and value). Returns true if at least one test is found to reference the given tag name and value. Otherwise return false.

Parameters:

pTagName - name of the tag to check

pTagValue - value of the tag to check

Returns:

Returns true if at least one test is found to reference the given tag name and value. Otherwise return false.

hasTestReferences

boolean hasTestReferences(java.lang.String pTagName)

Checks to see if one or more diagnostic tests reference the given tag name. References are either associations (i.e. test is tagged using the given name) or prerequisite (i.e. test prereqs the given tag name). Returns true if at least one test is found to reference the given tag name. Otherwise return false.

Parameters:

pTagName - name of the tag to check

Returns:

Returns true if at least one test is found to reference the given tag name. Otherwise return false.

exists

boolean exists(java.lang.String pTagName)

Checks if this tag exists in the repository.

The tag name must be set on this object prior to calling this method.

Parameters:

pTagName - name of the tag to check

Returns:

true if tag exists, false otherwise.

exists

boolean exists(java.lang.String pTagName,
               java.lang.String pTagValue)

Checks if this tag value exists in the repository.

The tag name must be set on this object prior to calling this method.

Parameters:

pTagName - name of the tag to check

pTagValue - name of the tag value tag to check

Returns:

true if tag exists, false otherwise.

fetchTagByName

Tag fetchTagByName(java.lang.String name)

Fetches tag definition for a particular tag using the tag name

Parameters:

name - name of the tag to detch

Returns:

the populated Tag object for the given tag name

fetchTagValue

TagValue fetchTagValue(java.lang.String tagName,
                       java.lang.String tagValue)

Fetches the tag value definition for a particular tag value using the given tag name and tag value

Parameters:

tagName - tag name

tagValue - tag value

Returns:

the populated TagValue object for the given tag name and value