org.openmrs.api

Enum ConceptNameType

java.lang.Object

java.lang.Enum<ConceptNameType>

org.openmrs.api.ConceptNameType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConceptNameType>

public enum ConceptNameType
extends java.lang.Enum<ConceptNameType>

The concept name type enumeration

FULLY_SPECIFIED - Indicates that the name is marked as the fully specified name, which is returned by default for a locale in case there is no preferred name set, a concept can have only one fully specified name per locale. It will also be set as the preferred name in its locale if no name is explicitly set as prefererred for the same locale and concept.

SHORT - Indicates the name is marked as the short name for the concept, only one name can be marked short per locale for a concept

INDEX_TERM - Indicates that the name is marked as a search term for the concept, it could be a common mis spelt version of any of the names for the concept, typically this name will be used for searching purposes.

NOTE: Any name with a null Concept name type is deemed a synonym. ONLY a fully specified name or synonym can be marked as preferred

Since:

Version 1.7

See Also:

ConceptName

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULLY_SPECIFIED
INDEX_TERM
SHORT

Method Summary

Modifier and Type	Method and Description
static ConceptNameType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConceptNameType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULLY_SPECIFIED

public static final ConceptNameType FULLY_SPECIFIED

SHORT

public static final ConceptNameType SHORT

INDEX_TERM

public static final ConceptNameType INDEX_TERM

Method Detail

values

public static ConceptNameType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConceptNameType c : ConceptNameType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConceptNameType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null