org.openmrs

Class Drug

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.Drug

All Implemented Interfaces:

Serializable, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable

public class Drug
extends BaseOpenmrsMetadata
implements Serializable

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
boolean	equals(Object obj) Compares two Drug objects for similarity
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()
Double	getDoseStrength() Gets the dose strength of this drug
Integer	getDrugId() Gets the internal identification number for this drug
String	getFullName(Locale locale) Gets the entires concept drug name in the form of CONCEPTNAME (Drug: DRUGNAME)
Integer	getId()
Double	getMaximumDailyDose()
Double	getMinimumDailyDose()
Concept	getRoute()
String	getUnits() Gets the units
int	hashCode()
Boolean	isCombination() Gets whether or not this is a combination drug
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	setDoseStrength(Double doseStrength) Sets the dose strength
void	setDrugId(Integer drugId) Sets the internal identification number for this drug
void	setId(Integer id)
void	setMaximumDailyDose(Double maximumDailyDose)
void	setMinimumDailyDose(Double minimumDailyDose)
void	setRoute(Concept route)
void	setUnits(String units) Sets the units

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

getUuid, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, 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

equals

public boolean equals(Object obj)

Compares two Drug objects for similarity

Overrides:

equals in class Object

Parameters:

obj -

Returns:

boolean true/false whether or not they are the same objects

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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 entires concept drug name in the form of CONCEPTNAME (Drug: DRUGNAME)

Parameters:

locale -

Returns:

full drug name (with concept name appended)

isCombination

public Boolean isCombination()

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 -

getDoseStrength

public Double getDoseStrength()

Gets the dose strength of this drug

Returns:

Double

setDoseStrength

public void setDoseStrength(Double doseStrength)

Sets the dose strength

Parameters:

doseStrength -

getUnits

public String getUnits()

Gets the units

Returns:

String

setUnits

public void setUnits(String units)

Sets the units

Parameters:

units -

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)

getRoute

public Concept getRoute()

setRoute

public void setRoute(Concept route)

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)

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