ConceptList (Oracle Healthcare Data Repository v8.0 API)

All Superinterfaces:

ConceptContainer
```
public interface ConceptList
extends ConceptContainer
```
Represents a list of Concept objects. ConceptList is useful for presenting a commonly used list of values to a user, such as a list of valid lab tests, a list of commonly prescribed pain medications, or a list of surgical procedures.

ConceptList objects are commonly used with UsageContext objects when user interactions involve lists of possible values. ConceptList defines the possible values for the entry, and UsageContext allows user-aware descriptions to be chosen to present the choices.

Certain members of a ConceptList may have to be cast to their specific terminology implementation class as the Concept objects within a ConceptList may come from more than one coding scheme version and from entirely different terminologies.

ConceptList objects have access restrictions, which are stored as extensibility values. Third party developers have no access to set the extensibility of a ConceptList. ConceptList objects can be defined as: system, extensible, and user. System-defined ConceptList objects are created and seeded by the supplier. Customers cannot add, remove, or update any Concept objects within this list. User-defined ConceptList objects are created by the customers and allow addition and modification of Concept objects. Extensible ConceptList objects are created by the supplier, but allow customers to add Concept objects into the list.

Parent-child ConceptList objects are implemented in ETS. The child ConceptList can be restricted. Restricted ConceptList objects can only add Concept objects or have Concept objects that are already included in their parent ConceptList objects. Children ConceptList objects also can inherit additions or deletions of Concept objects from its parent ConceptList. The inheritance behavior of restricted members is detailed in the following diagram:

ConceptList objects can be specialized by implementing usage contexts linking a specialized child ConceptList to its parent ConceptList. ConceptList objects have activation and retirement dates for the membership of their concept members. These dates are stored as a timestamp rounded to the nearest second. The following figure shows the behavior of retired ConceptList objects:

For an example of a concept list and its member, see CL_LIV_ADMINISTRATIVE_GENDER_CODE. To see the entire list of system and extensible lookup types, see here.

See Also:

ConceptContainer, Concept, UsageContext

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_VALIDATE` Deprecated. Use the EQUIVALENCE_TYPE constants on the `Concept` interface.
`static String`	`DEFAULT_GROUP` Default group name when a `null` group name is passed.
`static int`	`EXTENSIBILITY_EXTENSIBLE` Constant that defines the extensibility status of `ConceptList`.
`static int`	`EXTENSIBILITY_SYSTEM` Constant that defines the extensibility status of `ConceptList`.
`static int`	`EXTENSIBILITY_USER` Constant that defines the extensibility status of `ConceptList`.
`static int`	`IS_CONTAINED_VALIDATE` Deprecated. Use the EQUIVALENCE_TYPE constants on the `Concept` interface.
`static String`	`LOOKUPS_GROUP` Group to which `ConceptList` objects that represent lookups belong to.
`static int`	`MEMBER_DESC_ALL` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_LOCAL_PREF` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_LONG` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_NONE` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_PRINT` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_SHORT` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`MEMBER_DESC_TERMINOLOGY_PREF` Constant used to indicate the description type parameter for methods involving `ConceptListMember` objects.
`static int`	`NULL_IS_MAXDATE` Constant used by the `checkConceptIsRetirable` method to indicate the context of a `null` date parameter if one is passed in.
`static int`	`NULL_IS_SYSDATE` Constant used by the `checkConceptIsRetirable` method to indicate the context of a `null` date parameter if one is passed in.
`static int`	`STATUS_ACTIVE` Constant that defines the status of a `ConceptList` or the membership of a `Concept`.
`static int`	`STATUS_ACTIVE_OR_PENDING` Constant that defines the status of a `ConceptList` or the membership of a `Concept`.
`static int`	`STATUS_ALL` Constant that defines the status of a `ConceptList` or the membership of a `Concept`.
`static int`	`STATUS_PENDING` Constant that defines the status of a `ConceptList` or the membership of a `Concept`.
`static int`	`STATUS_RETIRED` Constant that defines the status of a `ConceptList` or the membership of a `Concept`.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkConceptIsAddable(Concept concept, String code, Date date)` Checks if the concept passed in can be added to the `ConceptList` with the specified membership code and at the specified future date.
`void`	`checkConceptIsRetirable(Concept concept, Date date, int nullDateContext)` Checks if the concept passed in can be retired at the specified future date.
`boolean`	`contains(Concept concept, Date date)` Indicates if the `ConceptList` contains the concept as an active member on a particular date.
`boolean`	`contains(Concept concept, int validationType)` Validates a concept in a `ConceptList`.
`boolean`	`contains(Concept concept, int validationType, int status)` Validates if a concept is a contained member in a `ConceptList`.
`Concept[]`	`getActiveConcepts(Date date)` Gets an array of all active concepts at a certain timestamp.
`ConceptList[]`	`getAllChildConceptLists()` Gets the active children, grandchildren, and all descendant `ConceptList` objects of this `ConceptList`.
`ConceptList`	`getChildConceptList(UsageContext context)` Gets the specialized child `ConceptList` using a usage context.
`ConceptList`	`getChildConceptListByName(String name)` Returns the specified child `ConceptList` of this `ConceptList`.
`ConceptList[]`	`getChildConceptLists()` Gets the immediate active children `ConceptList` objects of this `ConceptList`.
`Concept`	`getConceptByMembershipCode(String code)` Deprecated. Use `getConceptByMembershipCode(String,Date)`.
`Concept`	`getConceptByMembershipCode(String code, Date date)` Gets the `Concept` with the specified membership code.
`ConceptListMember`	`getConceptListMember(Concept con, Date date, int prefetchDescriptions, boolean prefetchConcept)` Gets the `ConceptListMember` associated with the specified `Concept` on the specified date.
`ConceptListMember`	`getConceptListMember(String membershipCode, Date date, int prefetchDescriptions, boolean prefetchConcept)` Gets the `ConceptListMember` associated with the specified membership code.
`ConceptListMember[]`	`getConceptListMembers(int prefetchDescriptions, boolean prefetchConcept)` Gets all the `ConceptListMember` objects that are active members.
`ConceptListMember[]`	`getConceptListMembers(int status, int prefetchDescriptions, boolean prefetchConcept)` Gets all the `ConceptListMember` objects that are of the specified status on the current date.
`Concept[]`	`getConcepts()` Gets all active member `Concept` objects contained within this `ConceptList`.
`Concept[]`	`getConcepts(int status)` Gets all the `Concept` objects that fit a particular state in the `ConceptList`.
`Concept[]`	`getConceptsByConceptCode(String conceptCode)` Gets any `Concept` members of this `ConceptList` object that have the specified concept code.
`Concept[]`	`getCoreSet()` Gets an array of active `Concept` objects that are in the core set of this `ConceptList`.
`Concept`	`getDefaultConcept()` Gets the default `Concept` member for this `ConceptList` object if it is an active or a pending concept member.
`String`	`getDescription()` Gets the description of this `ConceptList` object.
`Concept[]`	`getEquivalentConcepts(Concept concept, int equivalenceType)` Gets all concepts in this `ConceptList` equivalent to this `Concept` object using the requested equivalence method.
`Concept[]`	`getEquivalentConcepts(Concept concept, int equivalenceType, String equivalenceContext, boolean depthAllFlag)` Gets all concepts in this `ConceptList` equivalent to this `Concept` object using the requested equivalence method.
`String`	`getETSID()` Get the ETS identifier of this `ConceptList` object.
`int`	`getExtensibility()` Gets the extensibility of the `ConceptList`.
`String`	`getGroupName()` Gets the name of the group that the `ConceptList` belongs to.
`Date`	`getMembershipActivationDate(Concept concept)` Gets the activation date of membership of a `Concept` in a `ConceptList`.
`String`	`getMembershipCode(Concept concept)` Gets the membership code of an active or a pending member concept in the `ConceptList`.
`String`	`getMembershipCode(Concept concept, Date date)` Gets the membership code of a member concept that was active on a past date.
`Date`	`getMembershipRetirementDate(Concept concept)` Gets the retired date of membership of a `Concept` in a `ConceptList`.
`int`	`getMembershipStatus(Concept concept)` Gets the status of the membership of this `Concept` in the `ConceptList` on the current date.
`String`	`getName()` Gets the name of this `ConceptList` object.
`ConceptList`	`getParentConceptList()` Returns the parent `ConceptList` of this `ConceptList` object.
`ConceptList`	`getRootAncestorConceptList()` Gets the root parent `ConceptList` of this `ConceptList` object.
`UsageContext`	`getUsageContext()` Gets the usage context linked to this `ConceptList` object.
`boolean`	`isActive()` Indicates the status of this `ConceptList` object.
`boolean`	`isAdditionInherited()` Returns `true` if the `ConceptList` inherits additions of `Concept` objects from its parent.
`boolean`	`isCoreMember(Concept concept)` Indicates if `concept` belongs to the core set of the `ConceptList`.
`boolean`	`isDeletionInherited()` Returns `true` if the `ConceptList` inherits deletions of `Concept` objects from its parent.
`boolean`	`isRestricted()` Returns `true` if the `ConceptList` is restricted.
`boolean`	`isSystemMember(Concept concept, Date date)` Indicates if a concept is a system-defined member of `ConceptList` on the specified date.

Methods inherited from interface oracle.hsgbu.ets.base.ConceptContainer
contains, getAllConcepts, getConceptsWithAttribute, getConceptsWithAttributeName, getMatchingConceptsByDescriptionTerm, getMatchingConceptsByDescriptionTerm, getNumberOfConcepts

- Field Detail
  - STATUS_ACTIVE
```
static final int STATUS_ACTIVE
```
    Constant that defines the status of a ConceptList or the membership of a Concept. Active state requires the activation date of a Concept member to be set to the current date or date before the current date.
    
    See Also:
    
    Constant Field Values
  - STATUS_PENDING
```
static final int STATUS_PENDING
```
    Constant that defines the status of a ConceptList or the membership of a Concept. Pending state requires the activation date of a Concept member to be set to a date after the current date, and the retired date set to a date after its activation date.
    
    See Also:
    
    Constant Field Values
  - STATUS_RETIRED
```
static final int STATUS_RETIRED
```
    Constant that defines the status of a ConceptList or the membership of a Concept. Retired state requires the retired date of a Concept member to be set to the current date or a date before the current date, and the activation date to be set to its retired date or a date before its retired date.
    
    See Also:
    
    Constant Field Values
  - STATUS_ACTIVE_OR_PENDING
```
static final int STATUS_ACTIVE_OR_PENDING
```
    Constant that defines the status of a ConceptList or the membership of a Concept. This constant defines the Concept member or ConceptList to be in an active or pending state.
    
    See Also:
    
    Constant Field Values
  - STATUS_ALL
```
static final int STATUS_ALL
```
    Constant that defines the status of a ConceptList or the membership of a Concept. This constant defines the Concept member or ConceptList to be in active, pending, or retired states.
    
    See Also:
    
    Constant Field Values
  - EXTENSIBILITY_SYSTEM
```
static final int EXTENSIBILITY_SYSTEM
```
    Constant that defines the extensibility status of ConceptList. System-defined ConceptList objects are created and seeded by the supplier. Customers cannot add, remove, or update any Concept objects within this list.
    
    See Also:
    
    Constant Field Values
  - EXTENSIBILITY_USER
```
static final int EXTENSIBILITY_USER
```
    Constant that defines the extensibility status of ConceptList. User-defined ConceptList are created by the customers, and allow addition and modification of Concept objects.
    
    See Also:
    
    Constant Field Values
  - EXTENSIBILITY_EXTENSIBLE
```
static final int EXTENSIBILITY_EXTENSIBLE
```
    Constant that defines the extensibility status of ConceptList. Extensible ConceptList are created by the supplier, but allow customers to add Concept objects into the list.
    
    See Also:
    
    Constant Field Values
  - ALL_VALIDATE
```
static final int ALL_VALIDATE
```
    Deprecated. Use the EQUIVALENCE_TYPE constants on the Concept interface.
    
    Constant used by the contains(Concept, int, int) method to define validation mechanism to use. This constant checks for Concepts that are contained in either one of the validation mechanisms in the ConceptList.
    
    See Also:
    
    Constant Field Values
  - IS_CONTAINED_VALIDATE
```
static final int IS_CONTAINED_VALIDATE
```
    Deprecated. Use the EQUIVALENCE_TYPE constants on the Concept interface.
    
    Constant used by the contains(Concept, int, int) method to define validation mechanism to use. This constant checks for Concepts that are contained in the ConceptList.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GROUP
```
static final String DEFAULT_GROUP
```
    Default group name when a null group name is passed.
    
    See Also:
    
    Constant Field Values
  - LOOKUPS_GROUP
```
static final String LOOKUPS_GROUP
```
    Group to which ConceptList objects that represent lookups belong to.
    
    See Also:
    
    Constant Field Values
  - NULL_IS_SYSDATE
```
static final int NULL_IS_SYSDATE
```
    Constant used by the checkConceptIsRetirable method to indicate the context of a null date parameter if one is passed in. A null date parameter represents the current date.
    
    See Also:
    
    Constant Field Values
  - NULL_IS_MAXDATE
```
static final int NULL_IS_MAXDATE
```
    Constant used by the checkConceptIsRetirable method to indicate the context of a null date parameter if one is passed in. A null date parameter represents the maximum retirement date allowed.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_PRINT
```
static final int MEMBER_DESC_PRINT
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and a bit-wise OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_SHORT
```
static final int MEMBER_DESC_SHORT
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and a bit-wise OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_LONG
```
static final int MEMBER_DESC_LONG
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and an OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_TERMINOLOGY_PREF
```
static final int MEMBER_DESC_TERMINOLOGY_PREF
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and an OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_LOCAL_PREF
```
static final int MEMBER_DESC_LOCAL_PREF
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and an OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_ALL
```
static final int MEMBER_DESC_ALL
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects.
    
    See Also:
    
    Constant Field Values
  - MEMBER_DESC_NONE
```
static final int MEMBER_DESC_NONE
```
    Constant used to indicate the description type parameter for methods involving ConceptListMember objects. These constants are bit masks and an OR operation can be performed on these constants to represent prefetching of multiple descriptions.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Gets the name of this ConceptList object. The maximum length of this attribute is 50.
    
    Returns:
    
    Name of this ConceptList object.
  - getDescription
```
String getDescription()
```
    Gets the description of this ConceptList object.
    
    Returns:
    
    Description of this ConceptList object.
  - getDefaultConcept
```
Concept getDefaultConcept()
                   throws ETSNotFoundException,
                          ETSDataException
```
    Gets the default Concept member for this ConceptList object if it is an active or a pending concept member. The maximum length of this attribute is 240.
    
    Returns:
    
    Default Concept member of this ConceptList object if it is an active or a pending concept member.
    
    Throws:
    
    ETSNotFoundException - If this ConceptList object does not have a default Concept member that is an active or a pending member.
    
    ETSDataException - If a data transport error occurs.
  - getConceptsByConceptCode
```
Concept[] getConceptsByConceptCode(String conceptCode)
                            throws ETSBadParameterException,
                                   ETSDataException
```
    Gets any Concept members of this ConceptList object that have the specified concept code.
    
    Parameters:
    
    conceptCode - Concept code of the concepts to be retrieved.
    
    Returns:
    
    Array of matching Concept objects, or zero-length array if there is no match.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If argument passed is a null or zero-length concept code.
  - isActive
```
boolean isActive()
```
    Indicates the status of this ConceptList object.
    
    Returns:
    
    boolean value indicating if the ConceptList object is active or not.
  - getMembershipStatus
```
int getMembershipStatus(Concept concept)
                 throws ETSBadParameterException,
                        ETSDataException
```
    Gets the status of the membership of this Concept in the ConceptList on the current date.
    
    Parameters:
    
    concept - Concept to check membership status.
    
    Returns:
    
    Constants representing the status. These constants are STATUS_ACTIVE, STATUS_PENDING, or STATUS_RETIRED.
    
    Throws:
    
    ETSBadParameterException - If concept is null, or if concept is not a Concept member of the list.
    
    ETSDataException - If a data transport error occurs.
  - contains
```
boolean contains(Concept concept,
                 Date date)
          throws ETSBadParameterException,
                 ETSDataException
```
    Indicates if the ConceptList contains the concept as an active member on a particular date.
    
    Parameters:
    
    concept - Concept to check membership status.
    
    date - Date on which the status of this Concept must be found.
    
    Returns:
    
    true if the concept is an active member on the specified date.
    
    Throws:
    
    ETSBadParameterException - If concept or date is null.
    
    ETSDataException - If a data transport error occurs.
  - getActiveConcepts
```
Concept[] getActiveConcepts(Date date)
                     throws ETSDataException,
                            ETSBadParameterException
```
    Gets an array of all active concepts at a certain timestamp.
    
    Parameters:
    
    date - Timestamp to retrieve active concepts.
    
    Returns:
    
    Array of Concept objects that were active members of the ConceptList on the specified date, or an empty array if no concept is found.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If date is null.
  - getParentConceptList
```
ConceptList getParentConceptList()
                          throws ETSNotFoundException,
                                 ETSDataException
```
    Returns the parent ConceptList of this ConceptList object.
    
    Returns:
    
    Parent ConceptList of this ConceptList object.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSNotFoundException - If the ConceptList has no parent.
  - getRootAncestorConceptList
```
ConceptList getRootAncestorConceptList()
                                throws ETSNotFoundException,
                                       ETSDataException
```
    Gets the root parent ConceptList of this ConceptList object. This method returns the ConceptList itself if it is the root.
    
    Returns:
    
    Root parent ConceptList of this ConceptList object.
    
    Throws:
    
    ETSNotFoundException - If the ConceptList does not exist.
    
    ETSDataException - If a data transport error occurs.
  - getChildConceptListByName
```
ConceptList getChildConceptListByName(String name)
                               throws ETSBadParameterException,
                                      ETSNotFoundException,
                                      ETSDataException
```
    Returns the specified child ConceptList of this ConceptList.
    
    Parameters:
    
    name - Name of the child ConceptList to retrieve.
    
    Returns:
    
    Specified child ConceptList of this ConceptList.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If the argument passed is a null or an empty String.
    
    ETSNotFoundException - If the child ConceptList does not belong to the parent ConceptList.
  - getChildConceptList
```
ConceptList getChildConceptList(UsageContext context)
                         throws ETSBadParameterException,
                                ETSNotFoundException,
                                ETSDataException
```
    Gets the specialized child ConceptList using a usage context.
    
    Parameters:
    
    context - Usage context to retrieve a child ConceptList.
    
    Returns:
    
    Child ConceptList.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If context passed is a null.
    
    ETSNotFoundException - If a child ConceptList does not belong to the ConceptList with this context.
  - getChildConceptLists
```
ConceptList[] getChildConceptLists()
                            throws ETSDataException
```
    Gets the immediate active children ConceptList objects of this ConceptList.
    
    Returns:
    
    Immediate active children ConceptList objects of this ConceptList, or an empty array if no child exist.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - getAllChildConceptLists
```
ConceptList[] getAllChildConceptLists()
                               throws ETSDataException
```
    Gets the active children, grandchildren, and all descendant ConceptList objects of this ConceptList.
    
    Returns:
    
    Active children, grandchildren, and all descendant ConceptList objects of this ConceptList, or an empty array if no child exists.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - getConceptByMembershipCode
```
Concept getConceptByMembershipCode(String code)
                            throws ETSBadParameterException,
                                   ETSNotFoundException,
                                   ETSDataException
```
    Deprecated. Use getConceptByMembershipCode(String,Date).
    
    Gets the active member Concept with the specified membership code.
    
    Parameters:
    
    code - Unique membership code of the concept.
    
    Returns:
    
    Concept with this membership code.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If passed a null or an empty code String.
    
    ETSNotFoundException - If the Concept does not exist as an active member of the ConceptList.
  - getConceptByMembershipCode
```
Concept getConceptByMembershipCode(String code,
                                   Date date)
                            throws ETSBadParameterException,
                                   ETSNotFoundException,
                                   ETSDataException
```
    Gets the Concept with the specified membership code. This method uses server-side caching.
    NOTE: If caching is enabled, a volatile cache timeout of 15 minutes is enforced. Cached results are refreshed every 15 minutes. Subsequent calls to this method with differing date parameters that fall within this interval returns the cached result.
    
    Parameters:
    
    code - Unique membership code of the concept.
    
    date - Date to retrieve the membership code. If this argument is null, the current date is used to retrieve the membership code.
    
    Returns:
    
    Concept with this membership code.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If the arguments passed is a null or empty code String.
    
    ETSNotFoundException - If the concept does not exist as an active member of the ConceptList at the specified date.
  - getMembershipRetirementDate
```
Date getMembershipRetirementDate(Concept concept)
                          throws ETSBadParameterException,
                                 ETSDataException
```
    Gets the retired date of membership of a Concept in a ConceptList.
    
    Parameters:
    
    concept - Concept object.
    
    Returns:
    
    Retired date or null if the concept has not been retired. If a Concept has more than one retired date, the most recent retired date is returned.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If concept passed is a null, or a concept that does not belong to the ConceptList.
  - getGroupName
```
String getGroupName()
             throws ETSDataException
```
    Gets the name of the group that the ConceptList belongs to. The maximum length of this attribute is 50.
    
    Returns:
    
    name of the group that the ConceptList belongs to.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - getMembershipActivationDate
```
Date getMembershipActivationDate(Concept concept)
                          throws ETSDataException,
                                 ETSBadParameterException
```
    Gets the activation date of membership of a Concept in a ConceptList.
    
    Parameters:
    
    concept - Concept object.
    
    Returns:
    
    Activation date. If more than one activation date exists, the most recent activation date is returned.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If concept passed is a null, or a concept that does not belong to the ConceptList.
  - getConcepts
```
Concept[] getConcepts(int status)
               throws ETSDataException,
                      ETSBadParameterException
```
    Gets all the Concept objects that fit a particular state in the ConceptList. For example, if STATUS_PENDING is passed in, the method returns all pending concepts belonging to the list.
    
    Parameters:
    
    status - Constant representing the status of the concepts to retrieve. These constants are STATUS_ACTIVE, STATUS_PENDING, STATUS_RETIRED, or STATUS_ALL.
    
    Returns:
    
    Concepts in the ConceptList.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If status is null or not a valid value.
  - getConcepts
```
Concept[] getConcepts()
               throws ETSDataException
```
    Gets all active member Concept objects contained within this ConceptList.
    
    Returns:
    
    Array with all active member concepts in the ConceptList, or an empty array if no active member concept exists.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - getExtensibility
```
int getExtensibility()
              throws ETSDataException
```
    Gets the extensibility of the ConceptList. Extensibility determines what modifications are permitted on a ConceptList.
    
    Returns:
    
    Constant representing the extensibility value of the ConceptList. The constants are EXTENSIBILITY_SYSTEM, EXTENSIBILITY_USER, and EXTENSIBILITY_EXTENSIBLE.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - isRestricted
```
boolean isRestricted()
              throws ETSDataException
```
    Returns true if the ConceptList is restricted. Restricted ConceptList objects allow addition of concept members if their parent ConceptList also contains that concept as a member.
    
    Returns:
    
    true if the ConceptList is restricted.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - isAdditionInherited
```
boolean isAdditionInherited()
                     throws ETSDataException
```
    Returns true if the ConceptList inherits additions of Concept objects from its parent.
    
    Returns:
    
    true if the ConceptList inherits additions of Concept objects from its parent.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - isDeletionInherited
```
boolean isDeletionInherited()
                     throws ETSDataException
```
    Returns true if the ConceptList inherits deletions of Concept objects from its parent.
    
    Returns:
    
    true if the ConceptList inherits deletions of Concept objects from its parent.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - contains
```
boolean contains(Concept concept,
                 int validationType)
          throws ETSBadParameterException,
                 ETSDataException,
                 ETSUnsupportedOperationException
```
    Validates a concept in a ConceptList. Indicates if the concept is an active, contained member in the ConceptList.
    
    Parameters:
    
    concept - Concept being validated.
    
    validationType - Type of validation mechanism to use. Valid constants are EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_SEMANTIC, and EQUIVALENCE_TYPE_MAPPING on the Concept interface.
    
    Returns:
    
    true if the concept is an active, contained member in the ConceptList.
    
    Throws:
    
    ETSBadParameterException - If concept passed is null.
    
    ETSUnsupportedOperationException - If validationType is not EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_SEMANTIC, or EQUIVALENCE_TYPE_MAPPING.
    
    ETSDataException - If a data transport error occurs.
  - contains
```
boolean contains(Concept concept,
                 int validationType,
                 int status)
          throws ETSBadParameterException,
                 ETSDataException,
                 ETSUnsupportedOperationException
```
    Validates if a concept is a contained member in a ConceptList. Indicates if the concept being contained is "ACTIVE", "PENDING", or "RETIRED".
    
    Parameters:
    
    concept - Concept being validated.
    
    validationType - Type of validation mechanism to use. Valid constants are EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_SEMANTIC, and EQUIVALENCE_TYPE_MAPPING on the Concept interface.
    
    status - Status of the Concept being contained. The status can be STATUS_ACTIVE or STATUS_ACTIVE_OR_PENDING.
    
    Returns:
    
    true if the concept is an active, contained member in the ConceptList.
    
    Throws:
    
    ETSBadParameterException - If concept passed is null.
    
    ETSUnsupportedOperationException - If validationType or status is not one of the supported constants.
    
    ETSDataException - If a data transport error occurs.
  - isCoreMember
```
boolean isCoreMember(Concept concept)
              throws ETSBadParameterException,
                     ETSDataException,
                     ETSNotFoundException
```
    Indicates if concept belongs to the core set of the ConceptList.
    
    Parameters:
    
    concept - Concept object.
    
    Returns:
    
    true if this Concept is a core member.
    
    Throws:
    
    ETSBadParameterException - If concept passed is null.
    
    ETSDataException - If a data transport error occurs.
    
    ETSNotFoundException - If Concept is not found as an active or a pending member of the ConceptList.
  - getCoreSet
```
Concept[] getCoreSet()
              throws ETSDataException
```
    Gets an array of active Concept objects that are in the core set of this ConceptList.
    
    Returns:
    
    Array of active Concept objects that are in the core set of this ConceptList.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
  - getMembershipCode
```
String getMembershipCode(Concept concept)
                  throws ETSDataException,
                         ETSBadParameterException,
                         ETSNotFoundException
```
    Gets the membership code of an active or a pending member concept in the ConceptList. This method uses server-side caching. The maximum length of this attribute is 30.
    
    Parameters:
    
    concept - Concept object.
    
    Returns:
    
    Membership code of an active or a pending member concept in the ConceptList.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If concept passed is null.
    
    ETSNotFoundException - If concept is not an active or a pending member of the ConceptList.
  - getMembershipCode
```
String getMembershipCode(Concept concept,
                         Date date)
                  throws ETSDataException,
                         ETSBadParameterException,
                         ETSNotFoundException
```
    Gets the membership code of a member concept that was active on a past date. This method uses server-side caching. The maximum length of this attribute is 30.
    
    Parameters:
    
    concept - Concept object.
    
    date - Date to retrieve the membership code.
    
    Returns:
    
    Membership code of a member concept that was active on a past date.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If concept or date passed in is null.
    
    ETSNotFoundException - If concept is not an active member of the list on the specified date.
  - getUsageContext
```
UsageContext getUsageContext()
                      throws ETSDataException,
                             ETSNotFoundException
```
    Gets the usage context linked to this ConceptList object.
    
    Returns:
    
    Usage context of this ConceptList object.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSNotFoundException - If there is no usage context linked to this ConceptList object.
  - getETSID
```
String getETSID()
```
    Get the ETS identifier of this ConceptList object. The maximum length of this attribute is 30.
    
    Returns:
    
    ETS identifier of this ConceptList object.
  - isSystemMember
```
boolean isSystemMember(Concept concept,
                       Date date)
                throws ETSBadParameterException,
                       ETSDataException
```
    Indicates if a concept is a system-defined member of ConceptList on the specified date.
    
    Parameters:
    
    concept - Concept object.
    
    date - Date to retrieve the status of the concept. If current date is required, pass in a null date parameter.
    
    Returns:
    
    True if the concept is a system-defined member of the ConceptList at the specified date.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If concept passed is null.
  - checkConceptIsAddable
```
void checkConceptIsAddable(Concept concept,
                           String code,
                           Date date)
                    throws ETSBadParameterException,
                           ETSDuplicateException,
                           ETSDataException,
                           ETSUnsupportedOperationException
```
    Checks if the concept passed in can be added to the ConceptList with the specified membership code and at the specified future date. If the check passes, the method returns normally without throwing an exception. If the check fails, the exception that would have been thrown when calling ETSAdministrationService.addConceptToConceptList(oracle.hsgbu.ets.base.Concept, java.lang.String, oracle.hsgbu.ets.base.ConceptList,Date) is thrown, giving a brief text message of why the concept could not be added.
    Parameters:
    
    concept - Concept object.
    
    code - Concept membership code.
    
    date - Date when this Concept object has to be activated. If this argument is null, the default activation date is considered to be the current date.
    
    Throws:
    ETSBadParameterException -
    If code is null or an empty String.
    If activationDate is earlier than the current date.
    If concept is null.
    ETSDuplicateException -
    If concept already exists and is an active or a pending member in the ConceptList.
    If any children lists that inherit additions contain this Concept object.
    ETSUnsupportedOperationException -
    
    If ConceptList is system-defined.
    If ConceptList is restricted, and concept does not belong to the parent of the ConceptList.
    ETSDataException - If a data transport error occurs.
  - checkConceptIsRetirable
```
void checkConceptIsRetirable(Concept concept,
                             Date date,
                             int nullDateContext)
                      throws ETSBadParameterException,
                             ETSNotFoundException,
                             ETSDataException,
                             ETSUnsupportedOperationException
```
    Checks if the concept passed in can be retired at the specified future date. If the check passes, the method returns normally without throwing an exception. If the check fails, the exception that would have been thrown when calling ETSAdministrationService.retireConceptInConceptList(oracle.hsgbu.ets.base.Concept, oracle.hsgbu.ets.base.ConceptList) or ETSAdministrationService.updateMembershipRetirementDate(Concept, ConceptList, Date) is thrown, giving a brief text message of why the concept could not be retired or updated.
    Parameters:
    
    concept - Concept object.
    
    date - Date when this concept is to be retired. If this argument is null, the default value is the current date or the maximum allowable retirable date depending on the value of nullContext.
    
    nullDateContext - null date parameter can represent one of two contexts. It can represent the current date or the maximum allowable retirement date. If date is null, nullDateContext has to be passed in as "NULL_IS_SYSDATE" or "NULL_IS_MAXDATE".
    NOTE: If date is not null, this parameter value is ignored.
    
    Throws:
    ETSBadParameterException -
    
    If activationDate is earlier than the current date or is null.
    If any of the concept parameter is null.
    If a null date parameter is passed and an irrelevant nullDateContext is passed.
    If the date is after the retired date of the parent.
    ETSNotFoundException - If the concept does not belong to the ConceptList.
    
    ETSUnsupportedOperationException - If membership of Concept is system-defined, or if Concept is retired.
    
    ETSDataException - If a data transport error occurs.
  - getEquivalentConcepts
```
Concept[] getEquivalentConcepts(Concept concept,
                                int equivalenceType)
                         throws ETSDataException,
                                ETSBadParameterException
```
    Gets all concepts in this ConceptList equivalent to this Concept object using the requested equivalence method. This method uses server-side caching.
    
    Parameters:
    
    concept - Concept object.
    
    equivalenceType - Type of equivalence to be used.
    
    Returns:
    
    Array of concepts that are equivalent to the passed concept and contained in this ConceptList object, possibly including the passed concept itself. The return array may be zero-length.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    
    ETSBadParameterException - If Concept parameter passed is null or if the equivalence type is not recognized.
    
    See Also:
    
    EQUIVALENCE_TYPE_SEMANTIC
  - getEquivalentConcepts
```
Concept[] getEquivalentConcepts(Concept concept,
                                int equivalenceType,
                                String equivalenceContext,
                                boolean depthAllFlag)
                         throws ETSDataException,
                                ETSBadParameterException
```
    Gets all concepts in this ConceptList equivalent to this Concept object using the requested equivalence method. The concepts include both mapping and semantic equivalence concepts. To get only semantic equivalence concepts, use getEquivalentConcepts(Concept concept, int equivalenceType). This method uses server-side caching.
    Parameters:
    
    concept - Concept object.
    
    equivalenceType - Type of equivalence to be used. This method only accepts EQUIVALENCE_TYPE_MAPPING.
    
    equivalenceContext - Equivalence context of the mapping equivalence, such as "SYSTEM". It has to be registered through the ConceptList.
    
    depthAllFlag - Flag value of the depth of equivalence assertions that mapping equivalence service goes. If the flag value is true, this method considers all concepts in the set of concepts that are either directly equivalent (explicitly asserted to be equivalent through a cross map or a change file) or transitively equivalent (inferred to be equivalent by transitively chaining direct equivalence assertions) to this Concept. If the flag value is false, this method only considers the concepts that are directly equivalent.
    
    Returns:
    
    Array of concepts that are equivalent to the passed concept and contained in this ConceptList, possibly including the passed concept itself. The return array may be zero-length.
    
    Throws:
    
    ETSDataException - If a data transport error occurs.
    ETSBadParameterException -
    
    If concept parameter passed is null.
    If the equivalence type is not EQUIVALENCE_TYPE_MAPPING.
    If the equivalence context does not exist.
  - getConceptListMember
```
ConceptListMember getConceptListMember(Concept con,
                                       Date date,
                                       int prefetchDescriptions,
                                       boolean prefetchConcept)
                                throws ETSBadParameterException,
                                       ETSDataException,
                                       ETSNotFoundException
```
    Gets the ConceptListMember associated with the specified Concept on the specified date.
    Parameters:
    
    con - Concept that is a member of the ConceptList.
    
    date - Date to retrieve the member. If null, the date is the current date.
    prefetchDescriptions - Constant specifying the concept description texts to prefetch. Valid values are:
    
    MEMBER_DESC_PRINT
    MEMBER_DESC_SHORT
    MEMBER_DESC_LONG
    MEMBER_DESC_ALL
    MEMBER_DESC_NONE
    MEMBER_DESC_TERMINOLOGY_PREF
    MEMBER_DESC_LOCALLY_PREF
    
    These constants are defined in this interface. You can also define your own integer variable to pass in, by performing an OR operation on the descriptions you want to prefetch. For example, if you want to prefetch only the print name and the local preferred descriptions, you can pass in the following variable:
    int myConstant = MEMBER_DESC_SHORT | MEMBER_DESC_LOCALLY_PREF;
    prefetchConcept - Boolean specifying whether to prefetch the concept associated with the member. True indicates that the Concept object is prefetched and stored. False indicates that it is not prefetched and a null object is stored instead.
    
    Returns:
    
    ConceptListMember object.
    
    Throws:
    ETSBadParameterException -
    If the Concept object passed is a null.
    If the prefetchDescriptions value passed in is not one of the acceptable constants.
    ETSNotFoundException - If the concept does not exist as an active member of the ConceptList on the specified date.
    
    ETSDataException - If a data transport error occurs.
  - getConceptListMember
```
ConceptListMember getConceptListMember(String membershipCode,
                                       Date date,
                                       int prefetchDescriptions,
                                       boolean prefetchConcept)
                                throws ETSBadParameterException,
                                       ETSDataException,
                                       ETSNotFoundException
```
    Gets the ConceptListMember associated with the specified membership code.
    Parameters:
    
    membershipCode - Unique membership code of the concept.
    
    date - Date to retrieve the member. If null, the date is the current date.
    
    prefetchDescriptions - Integer constant specifying which concept description texts to prefetch.
    
    prefetchConcept - Boolean specifying whether to prefetch the concept. True indicates that the concept is prefetched and stored. False indicates that it is not prefetched and a null object is stored instead.
    
    Returns:
    
    ConceptListMember object.
    
    Throws:
    ETSBadParameterException -
    
    If membershipCode passed is a null or empty String.
    If prefetchDescriptions passed in is not one of the acceptable constants.
    ETSNotFoundException - If the concept does not exist as an active member of the ConceptList on the specified date.
    
    ETSDataException - If a data transport error occurs.
    
    See Also:
    
    getConceptListMember(Concept, java.util.Date, int, boolean)
  - getConceptListMembers
```
ConceptListMember[] getConceptListMembers(int status,
                                          int prefetchDescriptions,
                                          boolean prefetchConcept)
                                   throws ETSBadParameterException,
                                          ETSDataException,
                                          ETSNotFoundException
```
    Gets all the ConceptListMember objects that are of the specified status on the current date.
    
    Parameters:
    
    status - Constant representing the status of the members to retrieve. The constants are STATUS_ACTIVE_OR_PENDING, STATUS_ACTIVE, or STATUS_PENDING.
    
    prefetchDescriptions - Integer constant specifying which concept description texts to prefetch.
    
    prefetchConcept - Boolean specifying if the concept has to be prefetched. True indicates that the Concept object is prefetched and stored. False indicates that it is not prefetched and a null object is stored instead.
    
    Returns:
    
    ConceptListMember objects belonging to this ConceptList object with the specified state.
    
    Throws:
    
    ETSBadParameterException - If passed in a status or prefetchDescriptions value that is not one of the acceptable constants.
    
    ETSDataException - If a data transport error occurs.
    
    ETSNotFoundException
    
    See Also:
    
    getConceptListMember(Concept, java.util.Date, int, boolean)
  - getConceptListMembers
```
ConceptListMember[] getConceptListMembers(int prefetchDescriptions,
                                          boolean prefetchConcept)
                                   throws ETSBadParameterException,
                                          ETSDataException,
                                          ETSNotFoundException
```
    Gets all the ConceptListMember objects that are active members.
    
    Parameters:
    
    prefetchDescriptions - Integer constant specifying which concept description objects to prefetch.
    
    prefetchConcept - Boolean specifying if the concept has to be prefetched. True indicates that the Concept object is prefetched and stored. False indicates that it is not prefetched and a null object is stored instead.
    
    Returns:
    
    Active ConceptListMember objects belonging to this ConceptList object.
    
    Throws:
    
    ETSBadParameterException - If passed in a status or prefetchDescriptions that is not one of the acceptable constants.
    
    ETSDataException - If a data transport error occurs.
    
    ETSNotFoundException
    
    See Also:
    
    getConceptListMember(Concept, java.util.Date, int, boolean)

Interface ConceptList

Field Summary

Method Summary

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

Field Detail

STATUS_ACTIVE

STATUS_PENDING

STATUS_RETIRED

STATUS_ACTIVE_OR_PENDING

STATUS_ALL

EXTENSIBILITY_SYSTEM

EXTENSIBILITY_USER

EXTENSIBILITY_EXTENSIBLE

ALL_VALIDATE

IS_CONTAINED_VALIDATE

DEFAULT_GROUP

LOOKUPS_GROUP

NULL_IS_SYSDATE

NULL_IS_MAXDATE

MEMBER_DESC_PRINT

MEMBER_DESC_SHORT

MEMBER_DESC_LONG

MEMBER_DESC_TERMINOLOGY_PREF

MEMBER_DESC_LOCAL_PREF

MEMBER_DESC_ALL

MEMBER_DESC_NONE

Method Detail

getName

getDescription

getDefaultConcept

getConceptsByConceptCode

isActive

getMembershipStatus

contains

getActiveConcepts

getParentConceptList

getRootAncestorConceptList

getChildConceptListByName

getChildConceptList

getChildConceptLists

getAllChildConceptLists

getConceptByMembershipCode

getConceptByMembershipCode

getMembershipRetirementDate

getGroupName

getMembershipActivationDate

getConcepts

getConcepts

getExtensibility

isRestricted

isAdditionInherited

isDeletionInherited

contains

contains

isCoreMember

getCoreSet

getMembershipCode

getMembershipCode

getUsageContext

getETSID

isSystemMember

checkConceptIsAddable

checkConceptIsRetirable

getEquivalentConcepts

getEquivalentConcepts

getConceptListMember

getConceptListMember

getConceptListMembers

getConceptListMembers