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

All Superinterfaces:

DiagBObj<TagValue>, DiagConstants

All Known Implementing Classes:

AppsMsgIdTagValueImpl, TagValueImpl, WebAppNameTagValueImpl

public interface TagValue
extends DiagBObj<TagValue>

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/TagValue.java /main/11 2009/04/10 15:08:34 viramac 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

Method Summary

void	addTests(java.util.List<java.lang.String> pTestNames) Associates the given list of test names to this tag name value.
void	copy(TagValue pObj) Copies the contents of the given object into this object
void	create() This method will save the definition of this TagValue into the Applications Database.
boolean	exists() Checks if this tag value exists in the repository.
void	fetch() Fetches the tag value definition.
void	fetchAllTestIds(java.util.List<java.lang.String> pPrereqTestIds, java.util.List<java.lang.String> pInclTestIds, boolean pRecurse) Fetches test IDs for this tag value (note: the tag value ID must be set on this object prior to calling this API).
java.lang.String	getActiveFlag() Returns Active Flag value
java.lang.String	getDescription() Returns the description
java.lang.String	getDisplayName() Returns the tag value display name
java.lang.String	getParentTagValueId() Returns the parent tag value id
java.lang.String	getTagName() Returns the tag name
java.lang.String	getTagType() Returns the tag type e.g.
java.lang.String	getTagValue() Returns the tag value
java.lang.String	getTagValueId() Returns the tag value ID
TagValuePrereqList	getTagValuePrereqList() Returns the list of prerequisite tag values associated with this tag value object
java.lang.String	getTestAssocActiveFlag() Returns TestAssocActiveFlag value (Meaningful only in the context of a TestDef object)
boolean	hasTestReferences() Checks to see if this tag value is referred to from any diagnostic tests.
boolean	isCreatedAutomatically() Returns true if this tag-value is created automatically during loading of tests.
void	remove() Removes this tag value from the repository.
void	removeTests(java.util.List<java.lang.String> pTestNames) De-associates the given list of test names from this tag name value.
void	setActiveFlag(java.lang.String pActiveFlag) Sets the Active flag to indicate whether tag value is active or not.
void	setDescription(java.lang.String pDescription) Sets the tag value description
void	setDisplayName(java.lang.String pTagValueDisplayName) Sets the tag value display name
void	setParentTagValueId(java.lang.String pParentTagValueId) Sets the parent tag value id
void	setTagName(java.lang.String pTagName) Sets the tag name
void	setTagType(java.lang.String pTagType) Sets the tag value type to indicate whether it is taxonomy related or independent tag.
void	setTagValue(java.lang.String pTagValue) Sets the tag value
void	setTagValueId(java.lang.String pTagValueId) Sets the tag value ID
void	setTagValuePrereqList(TagValuePrereqList pTagValuePrereqList) Sets the tag value prerequisite list for this tag value object
void	setTestAssocActiveFlag(java.lang.String pTestAssocActiveFlag) Sets the pIsTestAssocActive flag to indicate whether TagValue-TestDef association is active or not.
void	validateForCreateAndSave() Performs validations required before creating a new tag on the database.

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

getTagValueId

java.lang.String getTagValueId()

Returns the tag value ID

Returns:

the tag value ID

getTagValue

java.lang.String getTagValue()

Returns the tag value

Returns:

the tag value

getParentTagValueId

java.lang.String getParentTagValueId()

Returns the parent tag value id

Returns:

the parent tag value id

getTagName

java.lang.String getTagName()

Returns the tag name

Returns:

the tag name

getDisplayName

java.lang.String getDisplayName()

Returns the tag value display name

Returns:

the tag value display name

getDescription

java.lang.String getDescription()

Returns the description

Returns:

the description

getTagType

java.lang.String getTagType()

Returns the tag type e.g. "T" for taxonomy or "N" for native

Returns:

the tag type

getActiveFlag

java.lang.String getActiveFlag()

Returns Active Flag value

Returns:

"Y" if Tag Value is active, else "N"

getTestAssocActiveFlag

java.lang.String getTestAssocActiveFlag()

Returns TestAssocActiveFlag value (Meaningful only in the context of a TestDef object)

Returns:

"Y" if TagValue-TestDef association is active

getTagValuePrereqList

TagValuePrereqList getTagValuePrereqList()

Returns the list of prerequisite tag values associated with this tag value object

Returns:

the list of TagValuePrereq objects

setTagValueId

void setTagValueId(java.lang.String pTagValueId)

Sets the tag value ID

Parameters:

pTagValueId - the tag value ID

setTagValue

void setTagValue(java.lang.String pTagValue)

Sets the tag value

Parameters:

pTagValue - the tag value

setParentTagValueId

void setParentTagValueId(java.lang.String pParentTagValueId)

Sets the parent tag value id

Parameters:

pParentTagValueId - the parent tag value id

setTagName

void setTagName(java.lang.String pTagName)

Sets the tag name

Parameters:

pTagName - the tag name

setDisplayName

void setDisplayName(java.lang.String pTagValueDisplayName)

Sets the tag value display name

Parameters:

pTagValueDisplayName - the tag value display name

setDescription

void setDescription(java.lang.String pDescription)

Sets the tag value description

Parameters:

pDescription - the tag value description

setTagType

void setTagType(java.lang.String pTagType)

Sets the tag value type to indicate whether it is taxonomy related or independent tag.

Parameters:

pTagType - tag value type.

setActiveFlag

void setActiveFlag(java.lang.String pActiveFlag)

Sets the Active flag to indicate whether tag value is active or not.

Parameters:

pActiveFlag - flag for the tag value

setTestAssocActiveFlag

void setTestAssocActiveFlag(java.lang.String pTestAssocActiveFlag)

Sets the pIsTestAssocActive flag to indicate whether TagValue-TestDef association is active or not. (Meaningful only in the context of a TestDef object)

Parameters:

pTestAssocActiveFlag - flag for the tag value

setTagValuePrereqList

void setTagValuePrereqList(TagValuePrereqList pTagValuePrereqList)

Sets the tag value prerequisite list for this tag value object

Parameters:

pTagValuePrereqList - tag value prerequisite list for this tag value objectn

copy

void copy(TagValue pObj)

Copies the contents of the given object into this object

Parameters:

pObj - the object to copy into this object.

fetchAllTestIds

void fetchAllTestIds(java.util.List<java.lang.String> pPrereqTestIds,
                     java.util.List<java.lang.String> pInclTestIds,
                     boolean pRecurse)

Fetches test IDs for this tag value (note: the tag value ID must be set on this object prior to calling this API). The fetched test IDs are divded into two categories : prerequisite tests, and included tests.
Prerequisite tests are tests that are prerequisites for this tag value id (either tests included in prerequisite tag values for this tag value or tests prerequisite to tests included in this tag value).
Included tests are tests that are included in this tag value (either as direct children or descendants via children tag values).
The prerequisites are placed in the pPrereqTestIds list while the includes are placed in the pInclTestIds list objects.

Parameters:

pPrereqTestIds - - List object where the API will add prerequisite test IDs.

pInclTestIds - - List object where the API will add included test IDs.

pRecurse - - if true, all nested tag values are also traversed. Otherwise, only the immediate prerequisites and children are traversed.

create

void create()
            throws DiagfwkException

This method will save the definition of this TagValue into the Applications Database. Clients will need to set all the required properties on this TagValue object prior to calling this method.

The required attributes are tagName, tagValue and displayName. The description attribute can also be populated optionally. If the tag value is getting created for the first time, this API for the tag automatically generates a tagValueId and sets it on this object.

Note: A tag entity with the given tag name should already exist prior to creating a tag value for that tag name.

Throws:

DiagfwkException - when any unexpected error occurs during the process of saving the tag value to the database.

validateForCreateAndSave

void validateForCreateAndSave()

Performs validations required before creating a new tag on the database.

addTests

void addTests(java.util.List<java.lang.String> pTestNames)
              throws DiagfwkException

Associates the given list of test names to this tag name value.

Parameters:

pTestNames - test names to associate with this tag name value

Throws:

DiagfwkException - when any error occurs.

removeTests

void removeTests(java.util.List<java.lang.String> pTestNames)
                 throws DiagfwkException

De-associates the given list of test names from this tag name value.

Parameters:

pTestNames - test names to de-associate from this tag name value

Throws:

DiagfwkException - when any error occurs.

hasTestReferences

boolean hasTestReferences()

Checks to see if this tag value is referred to from any diagnostic tests. References could be in the form of associations or prerequisite relationship.

Currently, requires tag name and tag value to be set prior to invoking this method.

Returns:

true if this tag value is referred to by at least one test. returns false otherwise.

remove

void remove()

Removes this tag value from the repository. Any tests that references this tag value are also cleaned up so that they no longer reference this tag value after this operation.

Tag name and tag value must be set prior to invoking this API.

exists

boolean exists()

Checks if this tag value exists in the repository.

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

Returns:

true if tag value exists, false otherwise.

fetch

void fetch()

Fetches the tag value definition. Tag name and value need to be set on this object prior to calling this method. Additionally, only the tag value definition for the given tag name and value is fetched; no child tag values are fetched.

isCreatedAutomatically

boolean isCreatedAutomatically()

Returns true if this tag-value is created automatically during loading of tests.

Returns: