Concept (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.Concept

All Implemented Interfaces:

Serializable, Attributable<Concept>, Auditable, Changeable, Creatable, Customizable<ConceptAttribute>, OpenmrsObject, Retireable

Direct Known Subclasses:

ConceptComplex, ConceptNumeric
```
@FullTextFilterDefs(value=@FullTextFilterDef(name="termsFilterFactory",impl=TermsFilterFactory.class))
public class Concept
extends BaseOpenmrsObject
implements Auditable, Retireable, Serializable, Attributable<Concept>, Customizable<ConceptAttribute>
```
A Concept object can represent either a question or an answer to a data point. That data point is usually an Obs.

A Concept can have multiple names and multiple descriptions within one locale and across multiple locales.

To save a Concept to the database, first build up the Concept object in java, then pass that object to the ConceptService.

To get a Concept that is stored in the database, call a method in the ConceptService to fetch an object. To get child objects off of that Concept, further calls to the ConceptService or the database are not needed. e.g. To get the list of answers that are stored to a concept, get the concept, then call getAnswers()

See Also:

ConceptName, ConceptDescription, ConceptAnswer, ConceptSet, ConceptMap, ConceptService, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

Concept()
default constructor

Concept(Integer conceptId)
Convenience constructor with conceptid to save to setConceptId(Integer).

Constructors
Constructor and Description
`Concept()` default constructor
`Concept(Integer conceptId)` Convenience constructor with conceptid to save to `setConceptId(Integer)`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnswer(ConceptAnswer conceptAnswer)` Add the given ConceptAnswer to the list of answers for this Concept
`void`	`addAttribute(ConceptAttribute attribute)` Adds an attribute.
`void`	`addConceptMapping(ConceptMap newConceptMap)` Add the given ConceptMap object to this concept's list of concept mappings.
`void`	`addDescription(ConceptDescription description)` Add the given description to the list of descriptions for this Concept
`void`	`addName(ConceptName conceptName)` Add the given ConceptName to the list of names for this Concept
`void`	`addSetMember(Concept setMember)` Appends the concept to the end of the existing list of concept members for this Concept
`void`	`addSetMember(Concept setMember, int index)` Add the concept to the existing member to the list of set members in the given location.
`ConceptName`	`findNameTaggedWith(ConceptNameTag conceptNameTag)` A convenience method to get the concept-name (if any) which has a particular tag.
`List<Concept>`	`findPossibleValues(String searchText)` Deprecated.
`Collection<ConceptAttribute>`	`getActiveAttributes()`
`List<ConceptAttribute>`	`getActiveAttributes(CustomValueDescriptor ofType)`
`Set<Locale>`	`getAllConceptNameLocales()` Convenience method that returns a set of all the locales in which names have been added for this concept.
`Collection<ConceptAnswer>`	`getAnswers()`
`Collection<ConceptAnswer>`	`getAnswers(boolean includeRetired)` If `includeRetired` is true, then the returned object is the actual stored list of `ConceptAnswer`s
`Set<ConceptAttribute>`	`getAttributes()`
`User`	`getChangedBy()`
`List<ConceptName>`	`getCompatibleNames(Locale desiredLocale)` Returns all names from compatible locales.
`ConceptClass`	`getConceptClass()`
`Integer`	`getConceptId()`
`Collection<ConceptMap>`	`getConceptMappings()`
`Collection<ConceptSet>`	`getConceptSets()`
`User`	`getCreator()`
`ConceptDatatype`	`getDatatype()`
`Date`	`getDateChanged()`
`Date`	`getDateCreated()`
`Date`	`getDateRetired()`
`ConceptDescription`	`getDescription()` Finds the description of the concept using the current locale in Context.getLocale().
`ConceptDescription`	`getDescription(Locale locale)` Finds the description of the concept in the given locale.
`ConceptDescription`	`getDescription(Locale locale, boolean exact)` Returns the preferred description for a locale.
`Collection<ConceptDescription>`	`getDescriptions()`
`String`	`getDisplayString()` Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user
`ConceptName`	`getFullySpecifiedName(Locale locale)` Convenience method that returns the fully specified name in the locale
`Integer`	`getId()`
`Collection<ConceptName>`	`getIndexTerms()` Gets the list of all non-retired concept names which are index terms for this concept
`Collection<ConceptName>`	`getIndexTermsForLocale(Locale locale)` Gets the list of all non-retired concept names which are index terms in a given locale
`ConceptName`	`getName()` Returns concept name, the look up for the appropriate name is done in the following order; First name found in any locale that is explicitly marked as preferred while searching available locales in order of preference (the locales are traversed in their order as they are listed in the 'locale.allowed.list' including english global property).
`ConceptName`	`getName(Locale locale)` Returns a name in the given locale.
`ConceptName`	`getName(Locale locale, boolean exact)` Returns a name in the given locale.
`ConceptName`	`getName(Locale locale, ConceptNameType ofType, ConceptNameTag havingTag)` Returns concept name depending of locale, type (short, fully specified, etc) and tag.
`Collection<ConceptName>`	`getNames()`
`Collection<ConceptName>`	`getNames(boolean includeVoided)`
`Collection<ConceptName>`	`getNames(Locale locale)` Returns all names available in a specific locale.
`List<Concept>`	`getPossibleValues()` Deprecated.
`ConceptName`	`getPreferredName(Locale forLocale)` Returns the name which is explicitly marked as preferred for a given locale.
`Boolean`	`getRetired()` This method delegates to `isRetired()`.
`User`	`getRetiredBy()`
`String`	`getRetireReason()`
`Boolean`	`getSet()`
`List<Concept>`	`getSetMembers()` Get all the concept members of current concept
`List<Concept>`	`getSetMembers(boolean includeRetired)` If includeRetired is true, then the returned object is the list of all the concept set members of current concept, else retired concept set members are excluded.
`ConceptName`	`getShortestName(Locale locale, Boolean exact)` Returns the short form name for a locale, or if none has been identified, the shortest name available in the locale.
`ConceptName`	`getShortNameInLocale(Locale locale)` Gets the explicitly specified short name for a locale.
`Collection<ConceptName>`	`getShortNames()` Gets a collection of short names for this concept from all locales.
`Collection<ConceptName>`	`getSynonyms()` Gets all the non-retired synonyms.
`Collection<ConceptName>`	`getSynonyms(Locale locale)` Gets the synonyms in the given locale.
`String`	`getVersion()`
`boolean`	`hasName(String name, Locale locale)` Checks whether this concept has the given string in any of the names in the given locale already.
`Concept`	`hydrate(String reference)` Deserialize the given string into a full object
`boolean`	`isComplex()` Child Class ConceptComplex overrides this method and returns true.
`boolean`	`isNamed(String name)`
`boolean`	`isNumeric()` Whether this concept is numeric or not.
`Boolean`	`isRetired()` Deprecated. as of 2.0, use `getRetired()`
`Boolean`	`isSet()` Deprecated. as of 2.0, use `getSet()`
`boolean`	`removeAnswer(ConceptAnswer conceptAnswer)` Remove the given answer from the list of answers for this Concept
`boolean`	`removeConceptMapping(ConceptMap conceptMap)` Remove the given ConceptMap from the list of mappings for this Concept
`boolean`	`removeDescription(ConceptDescription description)` Remove the given description from the list of descriptions for this Concept
`boolean`	`removeName(ConceptName conceptName)` Remove the given name from the list of names for this Concept
`String`	`serialize()` Turns this concept into a very simple serialized string
`void`	`setAnswers(Collection<ConceptAnswer> answers)` Set this Concept as having the given `answers`; This method assumes that the sort_weight has already been set.
`void`	`setAttributes(Set<ConceptAttribute> attributes)`
`void`	`setChangedBy(User changedBy)`
`void`	`setConceptClass(ConceptClass conceptClass)`
`void`	`setConceptId(Integer conceptId)`
`void`	`setConceptMappings(Collection<ConceptMap> conceptMappings)`
`void`	`setConceptSets(Collection<ConceptSet> conceptSets)`
`void`	`setCreator(User creator)`
`void`	`setDatatype(ConceptDatatype conceptDatatype)`
`void`	`setDateChanged(Date dateChanged)`
`void`	`setDateCreated(Date dateCreated)`
`void`	`setDateRetired(Date dateRetired)`
`void`	`setDescriptions(Collection<ConceptDescription> descriptions)` Sets the collection of descriptions for this Concept.
`void`	`setFullySpecifiedName(ConceptName fullySpecifiedName)` Sets the specified name as the fully specified name for the locale and the current fully specified (if any) ceases to be the fully specified name for the locale.
`void`	`setId(Integer id)`
`void`	`setNames(Collection<ConceptName> names)`
`void`	`setPreferredName(ConceptName preferredName)` Sets the preferred name /in this locale/ to the specified conceptName and its Locale, if there is an existing preferred name for this concept in the same locale, this one will replace the old preferred name.
`void`	`setRetired(Boolean retired)`
`void`	`setRetiredBy(User retiredBy)`
`void`	`setRetireReason(String retireReason)`
`void`	`setSet(Boolean set)`
`void`	`setShortName(ConceptName shortName)` Sets the specified name as the short name for the locale and the current shortName(if any) ceases to be the short name for the locale.
`void`	`setVersion(String version)`
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsObject
equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject
getUuid, setUuid

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Concept
```
public Concept()
```
    default constructor
  - Concept
```
public Concept(Integer conceptId)
```
    Convenience constructor with conceptid to save to setConceptId(Integer). This effectively creates a concept stub that can be used to make other calls. Because the BaseOpenmrsObject.equals(Object) and BaseOpenmrsObject.hashCode() methods rely on conceptId, this allows a stub to masquerade as a full concept as long as other objects like getAnswers() and getNames() are not needed/called.
    
    Parameters:
    
    conceptId - the concept id to set
- Method Detail
  - getAnswers
```
public Collection<ConceptAnswer> getAnswers()
```
    Returns:
    
    Returns all answers (including retired answers). Should return retired and non-retired answers Should not return null if answers is null or empty
  - getAnswers
```
public Collection<ConceptAnswer> getAnswers(boolean includeRetired)
```
    If includeRetired is true, then the returned object is the actual stored list of ConceptAnswers
    
    Parameters:
    
    includeRetired - true/false whether to also include the retired answers
    
    Returns:
    
    Returns the answers for this Concept Should return the same as getAnswers() if includeRetired is true Should not return retired answers if includeRetired is false
  - setAnswers
```
public void setAnswers(Collection<ConceptAnswer> answers)
```
    Set this Concept as having the given answers; This method assumes that the sort_weight has already been set.
    
    Parameters:
    
    answers - The answers to set.
  - addAnswer
```
public void addAnswer(ConceptAnswer conceptAnswer)
```
    Add the given ConceptAnswer to the list of answers for this Concept
    
    Parameters:
    
    conceptAnswer - Should add the ConceptAnswer to Concept Should not fail if answers list is null Should not fail if answers contains ConceptAnswer already Should set the sort weight to the max plus one if not provided
  - removeAnswer
```
public boolean removeAnswer(ConceptAnswer conceptAnswer)
```
    Remove the given answer from the list of answers for this Concept
    
    Parameters:
    
    conceptAnswer - answer to remove
    
    Returns:
    
    true if the entity was removed, false otherwise Should not fail if answers is empty Should not fail if given answer does not exist in list
  - getChangedBy
```
public User getChangedBy()
```
    Specified by:
    
    getChangedBy in interface Changeable
    
    Returns:
    
    Returns the changedBy.
  - setChangedBy
```
public void setChangedBy(User changedBy)
```
    Specified by:
    
    setChangedBy in interface Changeable
    
    Parameters:
    
    changedBy - The changedBy to set.
  - getConceptClass
```
public ConceptClass getConceptClass()
```
    Returns:
    
    Returns the conceptClass.
  - setConceptClass
```
public void setConceptClass(ConceptClass conceptClass)
```
    Parameters:
    
    conceptClass - The conceptClass to set.
  - isSet
```
@Deprecated
public Boolean isSet()
```
    Deprecated. as of 2.0, use getSet()
    
    whether or not this concept is a set
  - setSet
```
public void setSet(Boolean set)
```
    Parameters:
    
    set - whether or not this concept is a set
  - getSet
```
public Boolean getSet()
```
  - getDatatype
```
public ConceptDatatype getDatatype()
```
    Returns:
    
    Returns the conceptDatatype.
  - setDatatype
```
public void setDatatype(ConceptDatatype conceptDatatype)
```
    Parameters:
    
    conceptDatatype - The conceptDatatype to set.
  - getConceptId
```
public Integer getConceptId()
```
    Returns:
    
    Returns the conceptId.
  - setConceptId
```
public void setConceptId(Integer conceptId)
```
    Parameters:
    
    conceptId - The conceptId to set.
  - getCreator
```
public User getCreator()
```
    Specified by:
    
    getCreator in interface Creatable
    
    Returns:
    
    Returns the creator.
  - setCreator
```
public void setCreator(User creator)
```
    Specified by:
    
    setCreator in interface Creatable
    
    Parameters:
    
    creator - The creator to set.
  - getDateChanged
```
public Date getDateChanged()
```
    Specified by:
    
    getDateChanged in interface Changeable
    
    Returns:
    
    Returns the dateChanged.
  - setDateChanged
```
public void setDateChanged(Date dateChanged)
```
    Specified by:
    
    setDateChanged in interface Changeable
    
    Parameters:
    
    dateChanged - The dateChanged to set.
  - getDateCreated
```
public Date getDateCreated()
```
    Specified by:
    
    getDateCreated in interface Creatable
    
    Returns:
    
    Returns the dateCreated.
  - setDateCreated
```
public void setDateCreated(Date dateCreated)
```
    Specified by:
    
    setDateCreated in interface Creatable
    
    Parameters:
    
    dateCreated - The dateCreated to set.
  - setPreferredName
```
public void setPreferredName(ConceptName preferredName)
```
    Sets the preferred name /in this locale/ to the specified conceptName and its Locale, if there is an existing preferred name for this concept in the same locale, this one will replace the old preferred name. Also, the name is added to the concept if it is not already among the concept names.
    
    Parameters:
    
    preferredName - The name to be marked as preferred in its locale Should only allow one preferred name Should add the name to the list of names if it not among them before Should fail if the preferred name to set to is an index term
  - findNameTaggedWith
```
public ConceptName findNameTaggedWith(ConceptNameTag conceptNameTag)
```
    A convenience method to get the concept-name (if any) which has a particular tag. This does not guarantee that the returned name is the only one with the tag.
    
    Parameters:
    
    conceptNameTag - the tag for which to look
    
    Returns:
    
    the tagged name, or null if no name has the tag
  - getName
```
public ConceptName getName(Locale locale)
```
    Returns a name in the given locale. If a name isn't found with an exact match, a compatible locale match is returned. If no name is found matching either of those, the first name defined for this concept is returned.
    
    Parameters:
    
    locale - the locale to fetch for
    
    Returns:
    
    ConceptName attributed to the Concept in the given locale
    
    Since:
    
    1.5
    
    See Also:
    
    to get all the names for a locale,, for the preferred name (if any)
  - getName
```
public ConceptName getName()
```
    Returns concept name, the look up for the appropriate name is done in the following order;
    - First name found in any locale that is explicitly marked as preferred while searching available locales in order of preference (the locales are traversed in their order as they are listed in the 'locale.allowed.list' including english global property).
    - First "Fully Specified" name found while searching available locales in order of preference.
    - The first fully specified name found while searching through all names for the concept
    - The first synonym found while searching through all names for the concept.
    - The first random name found(except index terms) while searching through all names.
    Returns:
    
    ConceptName in the current locale or any locale if none found
    
    Since:
    
    1.5
    
    See Also:
    
    to get all the names for a locale, for the preferred name (if any) Should return the name explicitly marked as locale preferred if any is present Should return the fully specified name in a locale if no preferred name is set Should return null if the only added name is an index term Should return name in broader locale in case none is found in specific one
  - hasName
```
public boolean hasName(String name,
                       Locale locale)
```
    Checks whether this concept has the given string in any of the names in the given locale already.
    
    Parameters:
    
    name - the ConceptName.name to compare to
    
    locale - the locale to look in (null to check all locales)
    
    Returns:
    
    true/false whether the name exists already Should return false if name is null Should return true if locale is null but name exists Should return false if locale is null but name does not exist
  - getName
```
public ConceptName getName(Locale locale,
                           ConceptNameType ofType,
                           ConceptNameTag havingTag)
```
    Returns concept name depending of locale, type (short, fully specified, etc) and tag. Searches in the locale, and then the locale's parent if nothing is found.
    
    Parameters:
    
    ofType - find a name of this type (optional)
    
    havingTag - find a name with this tag (optional)
    
    locale - find a name with this locale (required)
    
    Returns:
    
    a name that matches the arguments, or null if none is found. If there are multiple matches and one is locale_preferred, that will be returned, otherwise a random one of the matches will be returned.
    
    Since:
    
    1.9
  - getName
```
public ConceptName getName(Locale locale,
                           boolean exact)
```
    Returns a name in the given locale. If a name isn't found with an exact match, a compatible locale match is returned. If no name is found matching either of those, the first name defined for this concept is returned.
    
    Parameters:
    
    locale - the language and country in which the name is used
    
    exact - true/false to return only exact locale (no default locale)
    
    Returns:
    
    the closest name in the given locale, or the first name
    
    See Also:
    
    to get all the names for a locale,, for the preferred name (if any) Should return exact name locale match given exact equals true Should return loose match given exact equals false Should return null if no names are found in locale given exact equals true Should return any name if no locale match given exact equals false Should return name in broader locale in case none is found in specific one
  - getPreferredName
```
public ConceptName getPreferredName(Locale forLocale)
```
    Returns the name which is explicitly marked as preferred for a given locale.
    
    Parameters:
    
    forLocale - locale for which to return a preferred name
    
    Returns:
    
    preferred name for the locale, or null if no preferred name is specified Should return the concept name explicitly marked as locale preferred Should return the fully specified name if no name is explicitly marked as locale preferred
  - getFullySpecifiedName
```
public ConceptName getFullySpecifiedName(Locale locale)
```
    Convenience method that returns the fully specified name in the locale
    
    Parameters:
    
    locale - locale from which to look up the fully specified name
    
    Returns:
    
    the name explicitly marked as fully specified for the locale Should return the name marked as fully specified for the given locale
  - getNames
```
public Collection<ConceptName> getNames(Locale locale)
```
    Returns all names available in a specific locale.
    
    This is recommended when managing the concept dictionary.
    
    Parameters:
    
    locale - locale for which names should be returned
    
    Returns:
    
    Collection of ConceptNames with the given locale
  - getCompatibleNames
```
public List<ConceptName> getCompatibleNames(Locale desiredLocale)
```
    Returns all names from compatible locales. A locale is considered compatible if it is exactly the same locale, or if either locale has no country specified and the language matches.
    
    This is recommended when presenting possible names to the use.
    
    Parameters:
    
    desiredLocale - locale with which the names should be compatible
    
    Returns:
    
    Collection of compatible names Should exclude incompatible country locales Should exclude incompatible language locales
  - setFullySpecifiedName
```
public void setFullySpecifiedName(ConceptName fullySpecifiedName)
```
    Sets the specified name as the fully specified name for the locale and the current fully specified (if any) ceases to be the fully specified name for the locale.
    
    Parameters:
    
    fullySpecifiedName - the new fully specified name to set Should set the concept name type of the specified name to fully specified Should convert the previous fully specified name if any to a synonym Should add the name to the list of names if it not among them before
  - setShortName
```
public void setShortName(ConceptName shortName)
```
    Sets the specified name as the short name for the locale and the current shortName(if any) ceases to be the short name for the locale.
    
    Parameters:
    
    shortName - the new shortName to set Should set the concept name type of the specified name to short Should convert the previous shortName if any to a synonym Should add the name to the list of names if it not among them before Should void old short name if new one is blank (do not save blanks!)
  - getShortNameInLocale
```
public ConceptName getShortNameInLocale(Locale locale)
```
    Gets the explicitly specified short name for a locale.
    
    Parameters:
    
    locale - locale for which to find a short name
    
    Returns:
    
    the short name, or null if none has been explicitly set
  - getShortNames
```
public Collection<ConceptName> getShortNames()
```
    Gets a collection of short names for this concept from all locales.
    
    Returns:
    
    a collection of all short names for this concept
  - getShortestName
```
public ConceptName getShortestName(Locale locale,
                                   Boolean exact)
```
    Returns the short form name for a locale, or if none has been identified, the shortest name available in the locale. If exact is false, the shortest name from any locale is returned
    
    Parameters:
    
    locale - the language and country in which the short name is used
    
    exact - true/false to return only exact locale (no default locale)
    
    Returns:
    
    the appropriate short name, or null if not found Should return the name marked as the shortName for the locale if it is present Should return the shortest name in a given locale for a concept if exact is true Should return the shortest name for the concept from any locale if exact is false Should return null if there are no names in the specified locale and exact is true
  - isNamed
```
public boolean isNamed(String name)
```
    Parameters:
    
    name - A name
    
    Returns:
    
    whether this concept has the given name in any locale
  - getIndexTerms
```
public Collection<ConceptName> getIndexTerms()
```
    Gets the list of all non-retired concept names which are index terms for this concept
    
    Returns:
    
    a collection of concept names which are index terms for this concept
    
    Since:
    
    1.7
  - getIndexTermsForLocale
```
public Collection<ConceptName> getIndexTermsForLocale(Locale locale)
```
    Gets the list of all non-retired concept names which are index terms in a given locale
    
    Parameters:
    
    locale - the locale for the index terms to return
    
    Returns:
    
    a collection of concept names which are index terms in the given locale
    
    Since:
    
    1.7
  - getNames
```
public Collection<ConceptName> getNames()
```
    Returns:
    
    Returns the names.
  - getNames
```
public Collection<ConceptName> getNames(boolean includeVoided)
```
    Parameters:
    
    includeVoided - Include voided ConceptNames if true.
    
    Returns:
    
    Returns the names.
  - setNames
```
public void setNames(Collection<ConceptName> names)
```
    Parameters:
    
    names - The names to set.
  - addName
```
public void addName(ConceptName conceptName)
```
    Add the given ConceptName to the list of names for this Concept
    
    Parameters:
    
    conceptName - Should replace the old preferred name with a current one Should replace the old fully specified name with a current one Should replace the old short name with a current one Should mark the first name added as fully specified
  - removeName
```
public boolean removeName(ConceptName conceptName)
```
    Remove the given name from the list of names for this Concept
    
    Parameters:
    
    conceptName -
    
    Returns:
    
    true if the entity was removed, false otherwise
  - getDescription
```
public ConceptDescription getDescription()
```
    Finds the description of the concept using the current locale in Context.getLocale(). Returns null if none found.
    
    Returns:
    
    ConceptDescription attributed to the Concept in the given locale
  - getDescription
```
public ConceptDescription getDescription(Locale locale)
```
    Finds the description of the concept in the given locale. Returns null if none found.
    
    Parameters:
    
    locale -
    
    Returns:
    
    ConceptDescription attributed to the Concept in the given locale
  - getDescription
```
public ConceptDescription getDescription(Locale locale,
                                         boolean exact)
```
    Returns the preferred description for a locale.
    
    Parameters:
    
    locale - the language and country in which the description is used
    
    exact - true/false to return only exact locale (no default locale)
    
    Returns:
    
    the appropriate description, or null if not found Should return match on locale exactly Should return match on language only Should not return match on language only if exact match exists Should not return language only match for exact matches
  - getRetiredBy
```
public User getRetiredBy()
```
    Specified by:
    
    getRetiredBy in interface Retireable
    
    Returns:
    
    the retiredBy
  - setRetiredBy
```
public void setRetiredBy(User retiredBy)
```
    Specified by:
    
    setRetiredBy in interface Retireable
    
    Parameters:
    
    retiredBy - the retiredBy to set
  - getDateRetired
```
public Date getDateRetired()
```
    Specified by:
    
    getDateRetired in interface Retireable
    
    Returns:
    
    the dateRetired
  - setDateRetired
```
public void setDateRetired(Date dateRetired)
```
    Specified by:
    
    setDateRetired in interface Retireable
    
    Parameters:
    
    dateRetired - the dateRetired to set
  - getRetireReason
```
public String getRetireReason()
```
    Specified by:
    
    getRetireReason in interface Retireable
    
    Returns:
    
    the retireReason
  - setRetireReason
```
public void setRetireReason(String retireReason)
```
    Specified by:
    
    setRetireReason in interface Retireable
    
    Parameters:
    
    retireReason - the retireReason to set
  - getDescriptions
```
public Collection<ConceptDescription> getDescriptions()
```
    Returns:
    
    Returns the descriptions.
  - setDescriptions
```
public void setDescriptions(Collection<ConceptDescription> descriptions)
```
    Sets the collection of descriptions for this Concept.
    
    Parameters:
    
    descriptions - the collection of descriptions
  - addDescription
```
public void addDescription(ConceptDescription description)
```
    Add the given description to the list of descriptions for this Concept
    
    Parameters:
    
    description - the description to add
  - removeDescription
```
public boolean removeDescription(ConceptDescription description)
```
    Remove the given description from the list of descriptions for this Concept
    
    Parameters:
    
    description - the description to remove
    
    Returns:
    
    true if the entity was removed, false otherwise Should should remove description passed from list of descriptions
  - isRetired
```
@Deprecated
public Boolean isRetired()
```
    Deprecated. as of 2.0, use getRetired()
    
    Specified by:
    
    isRetired in interface Retireable
    
    Returns:
    
    Returns the retired.
  - getRetired
```
public Boolean getRetired()
```
    This method delegates to isRetired(). This is only needed for jstl syntax like ${concept.retired} because the return type is a Boolean object instead of a boolean primitive type.
    
    Specified by:
    
    getRetired in interface Retireable
    
    See Also:
    
    Retireable.isRetired()
  - setRetired
```
public void setRetired(Boolean retired)
```
    Specified by:
    
    setRetired in interface Retireable
    
    Parameters:
    
    retired - The retired to set.
  - getSynonyms
```
public Collection<ConceptName> getSynonyms(Locale locale)
```
    Gets the synonyms in the given locale. Returns a list of names from the same language with the preferred synonym sorted first, or an empty list if none found.
    
    Parameters:
    
    locale -
    
    Returns:
    
    Collection of ConceptNames which are synonyms for the Concept in the given locale
  - getSynonyms
```
public Collection<ConceptName> getSynonyms()
```
    Gets all the non-retired synonyms.
    
    Returns:
    
    Collection of ConceptNames which are synonyms for the Concept or an empty list if none is found
    
    Since:
    
    1.7
  - getVersion
```
public String getVersion()
```
    Returns:
    
    Returns the version.
  - setVersion
```
public void setVersion(String version)
```
    Parameters:
    
    version - The version to set.
  - getConceptSets
```
public Collection<ConceptSet> getConceptSets()
```
    Returns:
    
    Returns the conceptSets.
  - setConceptSets
```
public void setConceptSets(Collection<ConceptSet> conceptSets)
```
    Parameters:
    
    conceptSets - The conceptSets to set.
  - isNumeric
```
public boolean isNumeric()
```
    Whether this concept is numeric or not. This will always return false for concept objects. ConceptNumeric.isNumeric() will then always return true.
    
    Returns:
    
    false
  - getConceptMappings
```
public Collection<ConceptMap> getConceptMappings()
```
    Returns:
    
    the conceptMappings for this concept
  - setConceptMappings
```
public void setConceptMappings(Collection<ConceptMap> conceptMappings)
```
    Parameters:
    
    conceptMappings - the conceptMappings to set
  - addConceptMapping
```
public void addConceptMapping(ConceptMap newConceptMap)
```
    Add the given ConceptMap object to this concept's list of concept mappings. If there is already a corresponding ConceptMap object for this concept already, this one will not be added.
    
    Parameters:
    
    newConceptMap -
  - isComplex
```
public boolean isComplex()
```
    Child Class ConceptComplex overrides this method and returns true. See ConceptComplex.isComplex(). Otherwise this method returns false.
    
    Returns:
    
    false
    
    Since:
    
    1.5
  - removeConceptMapping
```
public boolean removeConceptMapping(ConceptMap conceptMap)
```
    Remove the given ConceptMap from the list of mappings for this Concept
    
    Parameters:
    
    conceptMap -
    
    Returns:
    
    true if the entity was removed, false otherwise Should remove concept map passed from list of mappings
  - toString
```
public String toString()
```
    Description copied from class: BaseOpenmrsObject
    
    Returns a string equal to the value of:
    ClassName{hashCode=..., uuid=...}
    
    If the uuid field is null, it returns:
    ClassName{hashCode=...}
    Should include hashCode if uuid is null Should include uuid if not null
    
    Overrides:
    
    toString in class BaseOpenmrsObject
    
    See Also:
    
    Object.toString()
  - findPossibleValues
```
@Deprecated
public List<Concept> findPossibleValues(String searchText)
```
    Deprecated.
    
    Description copied from interface: Attributable
    
    Search for possible values of this object using the given search string
    
    Specified by:
    
    findPossibleValues in interface Attributable<Concept>
    
    Parameters:
    
    searchText - String to search on
    
    Returns:
    
    List of possible objects that can be assigned
    
    See Also:
    
    Attributable.findPossibleValues(java.lang.String)
  - getPossibleValues
```
@Deprecated
public List<Concept> getPossibleValues()
```
    Deprecated.
    
    Description copied from interface: Attributable
    
    Find all possible values of this object. For example, if this object is a Location, the database is delved into and all Location objects should be returned
    
    Specified by:
    
    getPossibleValues in interface Attributable<Concept>
    
    Returns:
    
    List of objects that can be assigned
    
    See Also:
    
    Attributable.getPossibleValues()
  - hydrate
```
public Concept hydrate(String reference)
```
    Description copied from interface: Attributable
    
    Deserialize the given string into a full object
    
    Specified by:
    
    hydrate in interface Attributable<Concept>
    
    Parameters:
    
    reference - String to deserialize
    
    Returns:
    
    hydrated object
    
    See Also:
    
    Attributable.hydrate(java.lang.String)
  - serialize
```
public String serialize()
```
    Turns this concept into a very simple serialized string
    
    Specified by:
    
    serialize in interface Attributable<Concept>
    
    Returns:
    
    String representing this object (Usually an identifier or primary key)
    
    See Also:
    
    Attributable.serialize()
  - getDisplayString
```
public String getDisplayString()
```
    Description copied from interface: Attributable
    
    Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user
    
    Specified by:
    
    getDisplayString in interface Attributable<Concept>
    
    Returns:
    
    String acceptable to display on a page
    
    See Also:
    
    Attributable.getDisplayString()
  - getAllConceptNameLocales
```
public Set<Locale> getAllConceptNameLocales()
```
    Convenience method that returns a set of all the locales in which names have been added for this concept.
    
    Returns:
    
    a set of all locales for names for this concept
    
    Since:
    
    1.7 Should return all locales for conceptNames for this concept without duplicates
  - getId
```
public Integer getId()
```
    Specified by:
    
    getId in interface OpenmrsObject
    
    Returns:
    
    id - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.getId()
  - setId
```
public void setId(Integer id)
```
    Specified by:
    
    setId in interface OpenmrsObject
    
    Parameters:
    
    id - - The unique Identifier for the object
    
    Since:
    
    1.5
    
    See Also:
    
    OpenmrsObject.setId(java.lang.Integer)
  - getSetMembers
```
public List<Concept> getSetMembers()
```
    Get all the concept members of current concept
    
    Returns:
    
    List<Concept> the Concepts that are members of this Concept's set Should return concept set members sorted according to the sort weight Should return all the conceptMembers of current Concept Should return unmodifiable list of conceptMember list Should return concept set members sorted with retired last
    
    Since:
    
    1.7
  - getSetMembers
```
public List<Concept> getSetMembers(boolean includeRetired)
```
    If includeRetired is true, then the returned object is the list of all the concept set members of current concept, else retired concept set members are excluded.
    
    Parameters:
    
    includeRetired - true/false whether to also include/exclude the retired concepts
    
    Since:
    
    2.5
  - addSetMember
```
public void addSetMember(Concept setMember)
```
    Appends the concept to the end of the existing list of concept members for this Concept
    
    Parameters:
    
    setMember - Concept to add to the Should add concept as a conceptSet Should append concept to the existing list of conceptSet Should place the new concept last in the list Should assign the calling component as parent to the ConceptSet
    
    Since:
    
    1.7
  - addSetMember
```
public void addSetMember(Concept setMember,
                         int index)
```
    Add the concept to the existing member to the list of set members in the given location.
    
    index of 0 is before the first concept
    index of -1 is after last.
    index of 1 is after the first but before the second, etc
    
    Parameters:
    
    setMember - the Concept to add as a child of this Concept
    
    index - where in the list of set members to put this setMember
    
    Since:
    
    1.7 Should assign the given concept as a ConceptSet Should insert the concept before the first with zero index Should insert the concept at the end with negative one index Should insert the concept in the third slot Should assign the calling component as parent to the ConceptSet Should add the concept to the current list of conceptSet
    
    See Also:
    
    getSortedConceptSets()
  - getAttributes
```
public Set<ConceptAttribute> getAttributes()
```
    Specified by:
    
    getAttributes in interface Customizable<ConceptAttribute>
    
    Returns:
    
    all attributes (including voided ones)
    
    See Also:
    
    Customizable.getAttributes()
  - getActiveAttributes
```
public Collection<ConceptAttribute> getActiveAttributes()
```
    Specified by:
    
    getActiveAttributes in interface Customizable<ConceptAttribute>
    
    Returns:
    
    non-voided attributes
    
    See Also:
    
    Customizable.getActiveAttributes()
  - getActiveAttributes
```
public List<ConceptAttribute> getActiveAttributes(CustomValueDescriptor ofType)
```
    Specified by:
    
    getActiveAttributes in interface Customizable<ConceptAttribute>
    
    Returns:
    
    non-voided attributes of the given type
    
    See Also:
    
    Customizable.getActiveAttributes(org.openmrs.customdatatype.CustomValueDescriptor)
  - setAttributes
```
public void setAttributes(Set<ConceptAttribute> attributes)
```
    Parameters:
    
    attributes - the attributes to set
  - addAttribute
```
public void addAttribute(ConceptAttribute attribute)
```
    Description copied from interface: Customizable
    
    Adds an attribute.
    
    Specified by:
    
    addAttribute in interface Customizable<ConceptAttribute>
    
    See Also:
    
    Customizable.addAttribute(Attribute)

Class Concept

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

Concept

Concept

Method Detail

getAnswers

getAnswers

setAnswers

addAnswer

removeAnswer

getChangedBy

setChangedBy

getConceptClass

setConceptClass

isSet

setSet

getSet

getDatatype

setDatatype

getConceptId

setConceptId

getCreator

setCreator

getDateChanged

setDateChanged

getDateCreated

setDateCreated

setPreferredName

findNameTaggedWith

getName

getName

hasName

getName

getName

getPreferredName

getFullySpecifiedName

getNames

getCompatibleNames

setFullySpecifiedName

setShortName

getShortNameInLocale

getShortNames

getShortestName

isNamed

getIndexTerms

getIndexTermsForLocale

getNames

getNames

setNames

addName

removeName

getDescription

getDescription

getDescription

getRetiredBy

setRetiredBy

getDateRetired

setDateRetired

getRetireReason

setRetireReason

getDescriptions

setDescriptions

addDescription

removeDescription

isRetired

getRetired

setRetired

getSynonyms

getSynonyms

getVersion

setVersion

getConceptSets