org.openmrs

Class Drug

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.Drug

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsMetadata, OpenmrsObject, Retireable

@Indexed
public class Drug
extends BaseChangeableOpenmrsMetadata

Drug

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Drug() default constructor
Drug(Integer drugId) constructor with id

Method Summary

Modifier and Type	Method and Description
void	addDrugReferenceMap(DrugReferenceMap drugReferenceMap) Add the given DrugReferenceMap object to this drug's list of drug reference mappings.
Boolean	getCombination()
Concept	getConcept() Gets the concept this drug is tied to
String	getDisplayName() Convenience method that returns a display name for the drug, defaults to drug.name
Concept	getDosageForm()
Concept	getDoseLimitUnits() Gets the doseLimitUnits which represents the units of the existing maximumDailyDose and minimumDailyDose
Integer	getDrugId() Gets the internal identification number for this drug
Set<DrugReferenceMap>	getDrugReferenceMaps()
String	getFullName(Locale locale) Gets the entries concept drug name in the form of CONCEPTNAME (Drug: DRUGNAME)
Integer	getId()
Collection<DrugIngredient>	getIngredients()
Double	getMaximumDailyDose()
Double	getMinimumDailyDose()
String	getStrength() Gets the strength
Boolean	isCombination() Deprecated. as of 2.0, use getCombination()
void	setCombination(Boolean combination) Sets whether or not this is a combination drug
void	setConcept(Concept concept) Sets the concept this drug is tied to
void	setDosageForm(Concept dosageForm)
void	setDoseLimitUnits(Concept doseLimitUnits) Sets the doseLimitUnits which represents the units of the existing maximumDailyDose and minimumDailyDose
void	setDrugId(Integer drugId) Sets the internal identification number for this drug
void	setDrugReferenceMaps(Set<DrugReferenceMap> drugReferenceMaps)
void	setId(Integer id)
void	setIngredients(Collection<DrugIngredient> ingredients)
void	setMaximumDailyDose(Double maximumDailyDose)
void	setMinimumDailyDose(Double minimumDailyDose)
void	setStrength(String strength) Sets the strength

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, toString

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

Drug

public Drug()

default constructor

Drug

public Drug(Integer drugId)

constructor with id

Method Detail

getDrugId

public Integer getDrugId()

Gets the internal identification number for this drug

Returns:

Integer

setDrugId

public void setDrugId(Integer drugId)

Sets the internal identification number for this drug

Parameters:

drugId -

getFullName

public String getFullName(Locale locale)

Gets the entries concept drug name in the form of CONCEPTNAME (Drug: DRUGNAME)

Parameters:

locale -

Returns:

full drug name (with concept name appended)

isCombination

@Deprecated
public Boolean isCombination()

Deprecated. as of 2.0, use getCombination()

Gets whether or not this is a combination drug

Returns:

Boolean

getCombination

public Boolean getCombination()

setCombination

public void setCombination(Boolean combination)

Sets whether or not this is a combination drug

Parameters:

combination -

getStrength

public String getStrength()

Gets the strength

Returns:

String

Since:

1.10

setStrength

public void setStrength(String strength)

Sets the strength

Parameters:

strength -

Since:

1.10

getConcept

public Concept getConcept()

Gets the concept this drug is tied to

Returns:

Concept

setConcept

public void setConcept(Concept concept)

Sets the concept this drug is tied to

Parameters:

concept -

getDosageForm

public Concept getDosageForm()

setDosageForm

public void setDosageForm(Concept dosageForm)

getMaximumDailyDose

public Double getMaximumDailyDose()

setMaximumDailyDose

public void setMaximumDailyDose(Double maximumDailyDose)

getMinimumDailyDose

public Double getMinimumDailyDose()

setMinimumDailyDose

public void setMinimumDailyDose(Double minimumDailyDose)

getIngredients

public Collection<DrugIngredient> getIngredients()

Returns:

Returns the ingredients

Since:

1.10

setIngredients

public void setIngredients(Collection<DrugIngredient> ingredients)

Parameters:

ingredients - The ingredients to set

Since:

1.10

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

getDisplayName

public String getDisplayName()

Convenience method that returns a display name for the drug, defaults to drug.name

Returns:

the display name

Since:

1.8.5, 1.9.4, 1.10

getDrugReferenceMaps

public Set<DrugReferenceMap> getDrugReferenceMaps()

Returns:

Returns the drugReferenceMaps.

Since:

1.10

setDrugReferenceMaps

public void setDrugReferenceMaps(Set<DrugReferenceMap> drugReferenceMaps)

Parameters:

drugReferenceMaps - The drugReferenceMaps to set.

Since:

1.10

addDrugReferenceMap

public void addDrugReferenceMap(DrugReferenceMap drugReferenceMap)

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

Parameters:

drugReferenceMap -

Since:

1.10 Should set drug as the drug to which a mapping is being added Should should not add duplicate drug reference maps

getDoseLimitUnits

public Concept getDoseLimitUnits()

Gets the doseLimitUnits which represents the units of the existing maximumDailyDose and minimumDailyDose

Returns:

the doseLimitUnits.

Since:

2.3.0

setDoseLimitUnits

public void setDoseLimitUnits(Concept doseLimitUnits)

Sets the doseLimitUnits which represents the units of the existing maximumDailyDose and minimumDailyDose

Parameters:

doseLimitUnits - The doseLimitUnits to set.

Since:

2.3.0