SimpleDosingInstructions (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseDosingInstructions
- - org.openmrs.SimpleDosingInstructions

All Implemented Interfaces:: DosingInstructions

public class SimpleDosingInstructions
extends BaseDosingInstructions

Since:: 1.10

Constructor Summary

Constructors
Constructor and Description

SimpleDosingInstructions()

Constructors
Constructor and Description
`SimpleDosingInstructions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAdministrationInstructions()`
`Boolean`	`getAsNeeded()`
`String`	`getAsNeededCondition()`
`Double`	`getDose()`
`Concept`	`getDoseUnits()`
`DosingInstructions`	`getDosingInstructions(DrugOrder order)` Get dosing instructions from order
`String`	`getDosingInstructionsAsString(Locale locale)` Get human-readable version of dosing instructions for a particular locale All dosing instructions can be localized, so the result, especially any free text may remain in the original language.
`Integer`	`getDuration()`
`Concept`	`getDurationUnits()`
`OrderFrequency`	`getFrequency()`
`Concept`	`getRoute()`
`void`	`setAdministrationInstructions(String administrationInstructions)`
`void`	`setAsNeeded(Boolean asNeeded)`
`void`	`setAsNeededCondition(String asNeededCondition)`
`void`	`setDose(Double dose)`
`void`	`setDoseUnits(Concept doseUnits)`
`void`	`setDosingInstructions(DrugOrder order)` Serialize dosing instructions into order
`void`	`setDuration(Integer duration)`
`void`	`setDurationUnits(Concept durationUnits)`
`void`	`setFrequency(OrderFrequency frequency)`
`void`	`setRoute(Concept route)`
`void`	`validate(DrugOrder order, org.springframework.validation.Errors errors)`

Methods inherited from class org.openmrs.BaseDosingInstructions
getAutoExpireDate

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

- Constructor Detail
  - SimpleDosingInstructions
```
public SimpleDosingInstructions()
```
- Method Detail
  - getDosingInstructionsAsString
```
public String getDosingInstructionsAsString(Locale locale)
```
    Description copied from interface: DosingInstructions
    
    Get human-readable version of dosing instructions for a particular locale All dosing instructions can be localized, so the result, especially any free text may remain in the original language. In general, it's expect that most implementations will write orders in a single language and then want to translate instructions to the patient's preferred language when printing orders for the patient. In all other cases, it will want to call this method with the user's locale (i.e., context.getLocale()).
    
    Returns:
    
    localized drug instructions string
    
    See Also:
    
    DosingInstructions.getDosingInstructionsAsString(java.util.Locale)
  - setDosingInstructions
```
public void setDosingInstructions(DrugOrder order)
```
    Description copied from interface: DosingInstructions
    
    Serialize dosing instructions into order
    
    Parameters:
    
    order - DrugOrder to set dosing instructions
    
    See Also:
    
    DosingInstructions.setDosingInstructions(DrugOrder)
  - getDosingInstructions
```
public DosingInstructions getDosingInstructions(DrugOrder order)
```
    Description copied from interface: DosingInstructions
    
    Get dosing instructions from order
    
    Parameters:
    
    order - DrugOrder to get dosing instructions
    
    Returns:
    
    DosingInstructions created from DrugOrder
    
    See Also:
    
    DosingInstructions.getDosingInstructions(DrugOrder)
  - validate
```
public void validate(DrugOrder order,
                     org.springframework.validation.Errors errors)
```
    Parameters:
    
    order -
    
    errors - Should reject a duration unit with a mapping of an invalid type
    
    See Also:
    
    DosingInstructions.validate(DrugOrder, org.springframework.validation.Errors)
  - getDose
```
public Double getDose()
```
  - setDose
```
public void setDose(Double dose)
```
  - getDoseUnits
```
public Concept getDoseUnits()
```
  - setDoseUnits
```
public void setDoseUnits(Concept doseUnits)
```
  - getRoute
```
public Concept getRoute()
```
  - setRoute
```
public void setRoute(Concept route)
```
  - getFrequency
```
public OrderFrequency getFrequency()
```
  - setFrequency
```
public void setFrequency(OrderFrequency frequency)
```
  - getDuration
```
public Integer getDuration()
```
  - setDuration
```
public void setDuration(Integer duration)
```
  - getDurationUnits
```
public Concept getDurationUnits()
```
  - setDurationUnits
```
public void setDurationUnits(Concept durationUnits)
```
  - getAsNeeded
```
public Boolean getAsNeeded()
```
  - setAsNeeded
```
public void setAsNeeded(Boolean asNeeded)
```
  - getAsNeededCondition
```
public String getAsNeededCondition()
```
  - setAsNeededCondition
```
public void setAsNeededCondition(String asNeededCondition)
```
  - getAdministrationInstructions
```
public String getAdministrationInstructions()
```
  - setAdministrationInstructions
```
public void setAdministrationInstructions(String administrationInstructions)
```

Class SimpleDosingInstructions

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseDosingInstructions

Methods inherited from class java.lang.Object

Constructor Detail

SimpleDosingInstructions

Method Detail

getDosingInstructionsAsString

setDosingInstructions

getDosingInstructions

validate

getDose

setDose

getDoseUnits

setDoseUnits

getRoute

setRoute

getFrequency

setFrequency

getDuration

setDuration

getDurationUnits

setDurationUnits

getAsNeeded

setAsNeeded

getAsNeededCondition

setAsNeededCondition

getAdministrationInstructions

setAdministrationInstructions