org.openmrs

Class ConceptReferenceTerm

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.ConceptReferenceTerm

All Implemented Interfaces:

java.io.Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable

public class ConceptReferenceTerm
extends BaseOpenmrsMetadata
implements java.io.Serializable

A concept reference term is typically name for a concept by which it is referred in another institution like ICD9, ICD10, SNOMED that keeps a concept dictionary or any other OpenMRS implementation

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConceptReferenceTerm() default constructor
ConceptReferenceTerm(ConceptSource source, java.lang.String code, java.lang.String name) Convenience constructor with the required fields filled in
ConceptReferenceTerm(java.lang.Integer conceptReferenceTermId) constructor with conceptReferenceTermId

Method Summary

Modifier and Type	Method and Description
void	addConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap) Add the given ConceptReferenceTermMap object to this concept reference term's list of concept reference term maps.
java.lang.String	getCode()
java.lang.Integer	getConceptReferenceTermId()
java.util.Set<ConceptReferenceTermMap>	getConceptReferenceTermMaps()
ConceptSource	getConceptSource()
java.lang.Integer	getId()
java.lang.String	getVersion()
boolean	removeConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap) Remove the given ConceptReferenceTermMap from the list of conceptReferenceTermMaps for this ConceptReferenceTerm
void	setCode(java.lang.String code)
void	setConceptReferenceTermId(java.lang.Integer conceptReferenceTermId)
void	setConceptReferenceTermMaps(java.util.Set<ConceptReferenceTermMap> conceptReferenceTermMaps)
void	setConceptSource(ConceptSource conceptSource)
void	setId(java.lang.Integer id)
void	setVersion(java.lang.String version)
java.lang.String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

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

Constructor Detail

ConceptReferenceTerm

public ConceptReferenceTerm()

default constructor

ConceptReferenceTerm

public ConceptReferenceTerm(java.lang.Integer conceptReferenceTermId)

constructor with conceptReferenceTermId

ConceptReferenceTerm

public ConceptReferenceTerm(ConceptSource source,
                            java.lang.String code,
                            java.lang.String name)

Convenience constructor with the required fields filled in

Parameters:

source - the ConceptSource belongs in

code - the code within that concept

name - the user readable name of this term

Since:

1.9.2, 1.10.0

Method Detail

getConceptReferenceTermId

public java.lang.Integer getConceptReferenceTermId()

Returns:

the conceptReferenceTermId

setConceptReferenceTermId

public void setConceptReferenceTermId(java.lang.Integer conceptReferenceTermId)

Parameters:

conceptReferenceTermId - the conceptReferenceTermId to set

getConceptSource

public ConceptSource getConceptSource()

Returns:

the conceptSource

setConceptSource

public void setConceptSource(ConceptSource conceptSource)

Parameters:

conceptSource - the conceptSource to set

getCode

public java.lang.String getCode()

Returns:

the code

setCode

public void setCode(java.lang.String code)

Parameters:

code - the code to set

getVersion

public java.lang.String getVersion()

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - the version to set

getConceptReferenceTermMaps

public java.util.Set<ConceptReferenceTermMap> getConceptReferenceTermMaps()

Returns:

the conceptReferenceTermMaps

setConceptReferenceTermMaps

public void setConceptReferenceTermMaps(java.util.Set<ConceptReferenceTermMap> conceptReferenceTermMaps)

Parameters:

conceptReferenceTermMaps - the conceptReferenceTermMaps to set

getId

public java.lang.Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

See Also:

OpenmrsObject.setId(java.lang.Integer)

addConceptReferenceTermMap

public void addConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap)

Add the given ConceptReferenceTermMap object to this concept reference term's list of concept reference term maps. If there is already a corresponding ConceptReferenceTermMap object for this concept reference term already, this one will not be added.

Parameters:

conceptReferenceTermMap -

removeConceptReferenceTermMap

public boolean removeConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap)

Remove the given ConceptReferenceTermMap from the list of conceptReferenceTermMaps for this ConceptReferenceTerm

Parameters:

conceptReferenceMap -

Returns:

true if the entity was removed, false otherwise

toString

public java.lang.String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()