oracle.hsgbu.ets.base

Interface ConceptDescription

All Superinterfaces:

AttributableETSComponent, ETSComponent, RetirableETSComponent

All Known Subinterfaces:

LocalConceptDescription, SNOMEDDescription, TerminologyConceptDescription

public interface ConceptDescription
extends RetirableETSComponent

Represents a single description for a Concept and may be associated with UsageContext. A ConceptDescription object may be specified by the terminology vendor or maintainer or may be locally specified by the customer.

See Also:

RetirableETSComponent, UsageContext, TerminologyConceptDescription, LocalConceptDescription

Method Summary

Modifier and Type	Method and Description
Concept	getConcept() Gets the concept associated with this ConceptDescription object.
String	getExtendedTypeCode() Gets the extended type code associated with this ConceptDescription object.
Locale	getLocale() Gets the language and territory code for this ConceptDescription object.
ConceptDescription[]	getSynonyms() Gets all local and terminology descriptions that describe the same concept as this ConceptDescription object.
String	getTerm() Gets the description text of this ConceptDescription object.
boolean	isLocal() Indicates if this ConceptDescription object is defined locally.
boolean	isLocallyPreferred() Indicates if this ConceptDescription object is designated as the locally-preferred description.
boolean	isTerminologyPreferred() Indicates if this ConceptDescription object is designated as the preferred description by the terminology vendor or maintainer.

Methods inherited from interface oracle.hsgbu.ets.base.RetirableETSComponent

getRetiredDate, getVersionID, isActive, isInternal, isQuarantined, isRetired

Methods inherited from interface oracle.hsgbu.ets.base.AttributableETSComponent

getAttributeNames, getAttributes, getAttributes

Methods inherited from interface oracle.hsgbu.ets.base.ETSComponent

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Method Detail

isTerminologyPreferred

boolean isTerminologyPreferred()

Indicates if this ConceptDescription object is designated as the preferred description by the terminology vendor or maintainer.

Returns:

true if the description is the preferred description by the terminology vendor or maintainer.

isLocallyPreferred

boolean isLocallyPreferred()

Indicates if this ConceptDescription object is designated as the locally-preferred description.

Returns:

true if the description is the locally-preferred description.

getTerm

String getTerm()

Gets the description text of this ConceptDescription object. The maximum length of this attribute is 4000.

Returns:

Description text of this ConceptDescription object.

getConcept

Concept getConcept()
            throws ETSNotFoundException,
                   ETSDataException

Gets the concept associated with this ConceptDescription object.

Returns:

Concept associated with this ConceptDescription object.

Throws:

ETSNotFoundException - If this ConceptDescription object is not attached to a concept.

ETSDataException - If a data transport error occurs.

getSynonyms

ConceptDescription[] getSynonyms()
                          throws ETSDataException

Gets all local and terminology descriptions that describe the same concept as this ConceptDescription object.

Returns:

Array of ConceptDescription objects.

Throws:

ETSDataException - If a data transport error occurs.

isLocal

boolean isLocal()

Indicates if this ConceptDescription object is defined locally.

Returns:

true if the description is defined locally.

getExtendedTypeCode

String getExtendedTypeCode()

Gets the extended type code associated with this ConceptDescription object. The maximum length of this attribute is 6.

Returns:

Extended type code associated with this ConceptDescription object.

Throws:

ETSDataException - If a data transport error occurs.

getLocale

Locale getLocale()

Gets the language and territory code for this ConceptDescription object. Every ConceptDescription in ETS is associated with a specific Locale. Note that this will not necessarily always be equal to the Locale parameter that was passed to the getDescription(..) method. Sometimes, when a given terminology does not contain any descriptions in the requested language, a description in a different language will be returned (as per the configured Locale mappings).

Returns:

The language and territory code for which this description has been written.

Since:

5.3

See Also:

Concept.getDescription(UsageContext, Locale)