oracle.hsgbu.ets.base

Interface ConceptListMember

public interface ConceptListMember

Represents a Concept member belonging to a ConceptList. A ConceptListMember contains information related to its associated Concept and to its membership in the ConceptList.

See Also:

ConceptList, Concept

Method Summary

Modifier and Type	Method and Description
Date	getActivationDate() Gets the membership activation date of ConceptListMember in its associated ConceptList.
Concept	getConcept() Gets the Concept object associated with this ConceptListMember.
ConceptList	getConceptList() Gets the ConceptList object to which this ConceptListMember belongs.
LocalConceptDescription	getLocalPreferredDescription() Gets the locally preferred description of this ConceptListMember object.
String	getLocalPreferredText() Gets the description text of the locally preferred description of this ConceptListMember object.
ConceptDescription	getLongNameDescription() Gets the long name description of this ConceptListMember object.
String	getLongNameText() Returns the description text of the long name of this ConceptListMember object.
String	getMembershipCode() Gets the membership code associated with this ConceptListMember object.
ConceptDescription	getPrintNameDescription() Gets the print name description of this ConceptListMember object.
String	getPrintNameText() Gets the description text of the print name of this ConceptListMember object.
Date	getRetirementDate() Gets the membership retirement date of ConceptListMember in its associated ConceptList.
ConceptDescription	getShortNameDescription() Gets the short name description of this ConceptListMember object.
String	getShortNameText() Gets the description text of the short name of this ConceptListMember object.
TerminologyConceptDescription	getTerminologyPreferredDescription() Gets the terminology-preferred description of this ConceptListMember object.
String	getTerminologyPreferredText() Gets the description text of the terminology-preferred description of this ConceptListMember object.
boolean	isCoreMember() Indicates if the ConceptListMember is a core member in its associated ConceptList.
boolean	isSystemMember() Indicates if the ConceptListMember is a system-defined member in the ConceptList.

Method Detail

getConcept

Concept getConcept()
            throws ETSDataException

Gets the Concept object associated with this ConceptListMember.

Returns:

Concept object.

Throws:

ETSDataException - If a data transport error occurs.

getConceptList

ConceptList getConceptList()
                    throws ETSDataException

Gets the ConceptList object to which this ConceptListMember belongs.

Returns:

ConceptList object.

Throws:

ETSDataException - If a data transport error occurs.

getMembershipCode

String getMembershipCode()

Gets the membership code associated with this ConceptListMember object. The maximum length of this attribute is 50.

Returns:

Membership code associated with this ConceptListMember object.

getActivationDate

Date getActivationDate()

Gets the membership activation date of ConceptListMember in its associated ConceptList.

Returns:

Membership activation date of ConceptListMember in its associated ConceptList.

getRetirementDate

Date getRetirementDate()

Gets the membership retirement date of ConceptListMember in its associated ConceptList.

Returns:

Membership retirement date of ConceptListMember in its associated ConceptList.

isSystemMember

boolean isSystemMember()

Indicates if the ConceptListMember is a system-defined member in the ConceptList.

Returns:

True if the member is system-defined.

isCoreMember

boolean isCoreMember()

Indicates if the ConceptListMember is a core member in its associated ConceptList.

Returns:

True if the member is a core member in its associated ConceptList.

getPrintNameDescription

ConceptDescription getPrintNameDescription()
                                    throws ETSDataException,
                                           ETSNotFoundException

Gets the print name description of this ConceptListMember object.

Returns:

Print name description of this ConceptListMember.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a print name description.

getShortNameDescription

ConceptDescription getShortNameDescription()
                                    throws ETSDataException,
                                           ETSNotFoundException

Gets the short name description of this ConceptListMember object.

Returns:

Short name description object of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a short name description.

getLongNameDescription

ConceptDescription getLongNameDescription()
                                   throws ETSDataException,
                                          ETSNotFoundException

Gets the long name description of this ConceptListMember object.

Returns:

Long name description object if one exists for this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a long name description.

getTerminologyPreferredDescription

TerminologyConceptDescription getTerminologyPreferredDescription()
                                                          throws ETSDataException,
                                                                 ETSNotFoundException

Gets the terminology-preferred description of this ConceptListMember object. This description will always exist for each Concept and ConceptListMember.

Returns:

Terminology-preferred description object of this ConceptListMember.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException

getLocalPreferredDescription

LocalConceptDescription getLocalPreferredDescription()
                                              throws ETSDataException,
                                                     ETSNotFoundException

Gets the locally preferred description of this ConceptListMember object.

Returns:

Locally preferred description object of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a locally preferred description.

getPrintNameText

String getPrintNameText()
                 throws ETSDataException,
                        ETSNotFoundException

Gets the description text of the print name of this ConceptListMember object. The maximum length of this attribute is 4000.

Returns:

Description text of the print name of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a print name description.

getShortNameText

String getShortNameText()
                 throws ETSDataException,
                        ETSNotFoundException

Gets the description text of the short name of this ConceptListMember object. The maximum length of this attribute is 4000.

Returns:

Description text of the short name of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a short name description.

getLongNameText

String getLongNameText()
                throws ETSDataException,
                       ETSNotFoundException

Returns the description text of the long name of this ConceptListMember object.

Returns:

Description text of the long name of this ConceptListMember object. The maximum length of this attribute is 4000.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a long name description.

getTerminologyPreferredText

String getTerminologyPreferredText()
                            throws ETSDataException

Gets the description text of the terminology-preferred description of this ConceptListMember object. The maximum length of this attribute is 4000.

Returns:

Description text of the terminology-preferred description of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

getLocalPreferredText

String getLocalPreferredText()
                      throws ETSDataException,
                             ETSNotFoundException

Gets the description text of the locally preferred description of this ConceptListMember object. The maximum length of this attribute is 4000.

Returns:

Description text of the locally preferred description of this ConceptListMember object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the member does not have a locally preferred description.