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

All Superinterfaces:

DiagBObj<Tag>, DiagConstants

All Known Implementing Classes:

TagImpl

public interface Tag
extends DiagBObj<Tag>

Models a tag entity

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(Tag t)
void	create() This method will save the definition of this tag into the Applications Database.
boolean	exists() Checks if this tag exists in the repository.
void	fetch() Fetches the definition for this tag.
java.lang.String	getDescription() Gets the description for the tag
java.lang.String	getDisplayName() Gets the tag display name
java.lang.String	getModuleId() Gets the Module ID for the taxonomy module that owns the seed data for this tag
java.lang.String	getTagId() Gets the tag id
java.lang.String	getTagName() Gets the tag name
TagValueList	getTagValueList() Gets the list of tag values for this tag
boolean	hasTestReferences() Checks to see if this tag is referred to from any diagnostic tests.
void	remove() Removes this tag from the repository.
void	setDescription(java.lang.String pDescription) Sets the description
void	setDisplayName(java.lang.String pDisplayName) Sets the tag display name
void	setModuleId(java.lang.String pModuleId) Sets the module ID
void	setTagId(java.lang.String pTagId) Sets the tag id
void	setTagName(java.lang.String pTagName) Sets the tag name
void	setTagValueList(TagValueList pTagValueList) Sets the tag value list for this list

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

getTagId

java.lang.String getTagId()

Gets the tag id

Returns:

the tag id

getTagName

java.lang.String getTagName()

Gets the tag name

Returns:

the tag name

getDisplayName

java.lang.String getDisplayName()

Gets the tag display name

Returns:

the tag display name

getDescription

java.lang.String getDescription()

Gets the description for the tag

Returns:

the description for the tag

getModuleId

java.lang.String getModuleId()

Gets the Module ID for the taxonomy module that owns the seed data for this tag

Returns:

the module ID for the taxonomy module that owns the seed data for this tag

setTagId

void setTagId(java.lang.String pTagId)

Sets the tag id

Parameters:

pTagId - the tag id

setTagName

void setTagName(java.lang.String pTagName)

Sets the tag name

Parameters:

pTagName - the tag name

setDisplayName

void setDisplayName(java.lang.String pDisplayName)

Sets the tag display name

Parameters:

pDisplayName - the tag display name

setDescription

void setDescription(java.lang.String pDescription)

Sets the description

Parameters:

pDescription - the description

setModuleId

void setModuleId(java.lang.String pModuleId)

Sets the module ID

Parameters:

pModuleId - the module ID

getTagValueList

TagValueList getTagValueList()

Gets the list of tag values for this tag

Returns:

the list of tag values for this tag

setTagValueList

void setTagValueList(TagValueList pTagValueList)

Sets the tag value list for this list

Parameters:

pTagValueList - the tag value list

copy

void copy(Tag t)

create

void create()
            throws DiagfwkException

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

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

Throws:

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

hasTestReferences

boolean hasTestReferences()

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

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

Returns:

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

remove

void remove()

Removes this tag from the repository. Any child tag values are also removed.

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

exists

boolean exists()

Checks if this tag exists in the repository.

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

Returns:

true if tag exists, false otherwise.

fetch

void fetch()

Fetches the definition for this tag. Tag name should be set on this object prior to calling this method.