org.openmrs

Class Drug

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.Drug

All Implemented Interfaces:

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

public class Drug
extends BaseOpenmrsMetadata
implements java.io.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(java.lang.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.
java.lang.Boolean	getCombination()
Concept	getConcept() Gets the concept this drug is tied to
java.lang.String	getDisplayName() Convenience method that returns a display name for the drug, defaults to drug.name
Concept	getDosageForm()
java.lang.Double	getDoseStrength() Deprecated.
java.lang.Integer	getDrugId() Gets the internal identification number for this drug
java.util.Set<DrugReferenceMap>	getDrugReferenceMaps()
java.lang.String	getFullName(java.util.Locale locale) Gets the entires concept drug name in the form of CONCEPTNAME (Drug: DRUGNAME)
java.lang.Integer	getId()
java.lang.Double	getMaximumDailyDose()
java.lang.Double	getMinimumDailyDose()
Concept	getRoute() Deprecated. moving it to order entry where it belongs.
java.lang.String	getStrength() Gets the strength
java.lang.String	getUnits() Deprecated.
java.lang.Boolean	isCombination() Gets whether or not this is a combination drug
void	setCombination(java.lang.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(java.lang.Double doseStrength) Deprecated.
void	setDrugId(java.lang.Integer drugId) Sets the internal identification number for this drug
void	setDrugReferenceMaps(java.util.Set<DrugReferenceMap> drugReferenceMaps)
void	setId(java.lang.Integer id)
void	setMaximumDailyDose(java.lang.Double maximumDailyDose)
void	setMinimumDailyDose(java.lang.Double minimumDailyDose)
void	setRoute(Concept route) Deprecated. moving it to order entry where it belongs.
void	setStrength(java.lang.String strength) Sets the strength
void	setUnits(java.lang.String units) Deprecated.

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(java.lang.Integer drugId)

constructor with id

Method Detail

getDrugId

public java.lang.Integer getDrugId()

Gets the internal identification number for this drug

Returns:

Integer

setDrugId

public void setDrugId(java.lang.Integer drugId)

Sets the internal identification number for this drug

Parameters:

drugId -

getFullName

public java.lang.String getFullName(java.util.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 java.lang.Boolean isCombination()

Gets whether or not this is a combination drug

Returns:

Boolean

getCombination

public java.lang.Boolean getCombination()

setCombination

public void setCombination(java.lang.Boolean combination)

Sets whether or not this is a combination drug

Parameters:

combination -

getDoseStrength

@Deprecated
public java.lang.Double getDoseStrength()

Deprecated.

Gets the dose strength of this drug

Returns:

Double

setDoseStrength

@Deprecated
public void setDoseStrength(java.lang.Double doseStrength)

Deprecated.

Sets the dose strength

Parameters:

doseStrength -

getUnits

@Deprecated
public java.lang.String getUnits()

Deprecated.

Gets the units

Returns:

String

setUnits

@Deprecated
public void setUnits(java.lang.String units)

Deprecated.

Sets the units

Parameters:

units -

getStrength

public java.lang.String getStrength()

Gets the strength

Returns:

String

Since:

1.10

setStrength

public void setStrength(java.lang.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 java.lang.Double getMaximumDailyDose()

setMaximumDailyDose

public void setMaximumDailyDose(java.lang.Double maximumDailyDose)

getMinimumDailyDose

public java.lang.Double getMinimumDailyDose()

setMinimumDailyDose

public void setMinimumDailyDose(java.lang.Double minimumDailyDose)

getRoute

@Deprecated
public Concept getRoute()

Deprecated. moving it to order entry where it belongs.

setRoute

@Deprecated
public void setRoute(Concept route)

Deprecated. moving it to order entry where it belongs.

getId

public java.lang.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(java.lang.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 java.lang.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 java.util.Set<DrugReferenceMap> getDrugReferenceMaps()

Returns:

Returns the drugReferenceMaps.

Since:

1.10

setDrugReferenceMaps

public void setDrugReferenceMaps(java.util.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