org.openmrs.api.impl

Class OrderServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.OrderServiceImpl

All Implemented Interfaces:

OpenmrsService, OrderService

public class OrderServiceImpl
extends BaseOpenmrsService
implements OrderService

Default implementation of the Order-related services class. This method should not be invoked by itself. Spring injection is used to inject this implementation into the ServiceContext. Which implementation is injected is determined by the spring application context file: /metadata/api/spring/applicationContext.xml

See Also:

OrderService

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmrs.api.OrderService

OrderService.ORDER_STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected OrderDAO	dao
protected org.apache.commons.logging.Log	log

Fields inherited from interface org.openmrs.api.OrderService

SHOW_ALL, SHOW_COMPLETE, SHOW_CURRENT, SHOW_CURRENT_AND_FUTURE, SHOW_NOTVOIDED

Constructor Summary

Constructors

Constructor and Description
OrderServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	createOrder(Order order) Deprecated.
void	createOrdersAndEncounter(Patient p, Collection<Order> orders) TODO: Refactor, generalize, or remove this method
void	createOrderType(OrderType orderType) Deprecated.
void	deleteOrder(Order order) Deprecated.
void	deleteOrderType(OrderType orderType) Deprecated.
void	discontinueAllOrders(Patient patient, Concept discontinueReason, Date discontinueDate) Deprecated. use OrderUtil.discontinueAllOrders(Patient, Concept, Date)
void	discontinueDrugSet(Patient patient, String drugSetId, Concept discontinueReason, Date discontinueDate) Deprecated. use OrderUtil.discontinueDrugSet(Patient, String, Concept, Date)
Order	discontinueOrder(Order order, Concept discontinueReason, Date discontinueDate) Mark the given order as discontinued.
List<OrderType>	getAllOrderTypes() Get all order types, including retired ones
List<OrderType>	getAllOrderTypes(boolean includeRetired) Get all order types, only showing ones not marked as retired if includeRetired is true
DrugOrder	getDrugOrder(Integer drugOrderId) Deprecated.
List<DrugOrder>	getDrugOrders() Deprecated. This is a dumb method
List<DrugOrder>	getDrugOrdersByPatient(Patient patient) Get all orders for the given patient
List<DrugOrder>	getDrugOrdersByPatient(Patient patient, int whatToShow) Deprecated.
List<DrugOrder>	getDrugOrdersByPatient(Patient patient, int whatToShow, boolean includeVoided) Deprecated.
List<DrugOrder>	getDrugOrdersByPatient(Patient patient, OrderService.ORDER_STATUS orderStatus) Get drug orders for a given patient, not including voided orders
List<DrugOrder>	getDrugOrdersByPatient(Patient patient, OrderService.ORDER_STATUS orderStatus, boolean includeVoided) Get drug orders for a given patient
Map<String,String>	getDrugSetHeadersByDrugSetIdList(String drugSetIds) Deprecated. use OrderUtil.getDrugSetHeadersByDrugSetIdList(String)
Map<Concept,List<DrugOrder>>	getDrugSetsByConcepts(List<DrugOrder> drugOrders, List<Concept> drugSets) Deprecated. use OrderUtil.getDrugSetsByConcepts(List, List)
Map<String,List<DrugOrder>>	getDrugSetsByDrugSetIdList(List<DrugOrder> orderList, String drugSetIdList, String delimiter) Deprecated. use OrderUtil.getDrugSetsByDrugSetIdList(List, String, String)
Order	getOrder(Integer orderId) Get order by internal primary key identifier
<o extends Order> o	getOrder(Integer orderId, Class<o> orderClassType) Gets the order with the associated order id
Order	getOrderByUuid(String uuid) Get Order by its UUID
List<Order>	getOrders() Deprecated. This is a dumb method
<Ord extends Order> List<Ord>	getOrders(Class<Ord> orderClassType, List<Patient> patients, List<Concept> concepts, OrderService.ORDER_STATUS status, List<User> orderers, List<Encounter> encounters, List<OrderType> orderTypes) This searches for orders given the parameters.
List<Order>	getOrdersByEncounter(Encounter encounter) Gets all orders contained in an encounter
List<Order>	getOrdersByPatient(Patient patient) Get all orders by Patient
List<Order>	getOrdersByUser(User user) Get all orders by the User that is marked as their orderer
OrderType	getOrderType(Integer orderTypeId) Get orderType by internal identifier
OrderType	getOrderTypeByUuid(String uuid) Get OrderType by its UUID
List<OrderType>	getOrderTypes() Deprecated.
List<RegimenSuggestion>	getStandardRegimens() The standard regimens are currently stored in the application context file.
void	purgeOrder(Order order) Completely delete an order from the database.
void	purgeOrder(Order order, boolean cascade)
void	purgeOrderType(OrderType orderType) Completely delete the order type from the system.
OrderType	retireOrderType(OrderType orderType, String reason) This method essentially takes the given orderType out of active use in OpenMRS.
Order	saveOrder(Order order) Save or update the given order in the database
OrderType	saveOrderType(OrderType orderType) Save or update the given orderType in the database
void	setOrderDAO(OrderDAO dao) Setter for the Order data access object.
Order	undiscontinueOrder(Order order) Un-discontinue order record.
OrderType	unretireOrderType(OrderType orderType) This will bring back a previously decommissioned OrderType
Order	unvoidOrder(Order order) Unvoid order record.
void	updateOrder(Order order) Deprecated.
void	updateOrderType(OrderType orderType) Deprecated.
void	voidDrugSet(Patient patient, String drugSetId, String voidReason, int whatToVoid) Deprecated. use OrderUtil.voidDrugSet(Patient, String, String, org.openmrs.api.OrderService.ORDER_STATUS)
Order	voidOrder(Order order, String voidReason) Mark an order as voided.

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Field Detail

log

protected final org.apache.commons.logging.Log log

dao

protected OrderDAO dao

Constructor Detail

OrderServiceImpl

public OrderServiceImpl()

Method Detail

setOrderDAO

public void setOrderDAO(OrderDAO dao)

Description copied from interface: OrderService

Setter for the Order data access object. The dao is used for saving and getting orders to/from the database

Specified by:

setOrderDAO in interface OrderService

Parameters:

dao - The data access object to use

See Also:

OrderService.setOrderDAO(org.openmrs.api.db.OrderDAO)

saveOrder

public Order saveOrder(Order order)
                throws APIException

Description copied from interface: OrderService

Save or update the given order in the database

Specified by:

saveOrder in interface OrderService

Parameters:

order - the Order to save

Returns:

the Order that was saved

Throws:

APIException

See Also:

OrderService.saveOrder(org.openmrs.Order)

createOrder

@Deprecated
public void createOrder(Order order)
                             throws APIException

Deprecated.

Specified by:

createOrder in interface OrderService

Throws:

APIException

See Also:

OrderService.createOrder(org.openmrs.Order)

updateOrder

@Deprecated
public void updateOrder(Order order)
                             throws APIException

Deprecated.

Specified by:

updateOrder in interface OrderService

Throws:

APIException

See Also:

OrderService.updateOrder(org.openmrs.Order)

deleteOrder

@Deprecated
public void deleteOrder(Order order)
                             throws APIException

Deprecated.

Specified by:

deleteOrder in interface OrderService

Throws:

APIException

See Also:

OrderService.deleteOrder(org.openmrs.Order)

purgeOrder

public void purgeOrder(Order order)
                throws APIException

Description copied from interface: OrderService

Completely delete an order from the database. This should not typically be used unless desperately needed. Most orders should just be voided. See OrderService.voidOrder(Order, String)

Specified by:

purgeOrder in interface OrderService

Parameters:

order - The Order to remove from the system

Throws:

APIException

See Also:

OrderService.purgeOrder(org.openmrs.Order)

purgeOrder

public void purgeOrder(Order order,
                       boolean cascade)
                throws APIException

Throws:

APIException

See Also:

OrderService.purgeOrder(Order)

voidOrder

public Order voidOrder(Order order,
                       String voidReason)
                throws APIException

Description copied from interface: OrderService

Mark an order as voided. This functionally removes the Order from the system while keeping a semblance

Specified by:

voidOrder in interface OrderService

Parameters:

order - Order to void

voidReason - String reason

Returns:

the Order that was voided

Throws:

APIException

See Also:

OrderService.voidOrder(org.openmrs.Order, java.lang.String)

unvoidOrder

public Order unvoidOrder(Order order)
                  throws APIException

Description copied from interface: OrderService

Unvoid order record. Reverse a previous call to OrderService.voidOrder(Order, String)

Specified by:

unvoidOrder in interface OrderService

Parameters:

order - order to be unvoided

Returns:

the Order that was unvoided

Throws:

APIException

See Also:

OrderService.unvoidOrder(org.openmrs.Order)

discontinueOrder

public Order discontinueOrder(Order order,
                              Concept discontinueReason,
                              Date discontinueDate)
                       throws APIException

Description copied from interface: OrderService

Mark the given order as discontinued. This should be used when patients are no longer on this Order. If this is was invalid Order, the OrderService.voidOrder(Order, String) method should probably be used.

Specified by:

discontinueOrder in interface OrderService

Parameters:

order - Order to discontinue

discontinueReason - String reason for discontinuing this order

Returns:

The Order that was discontinued

Throws:

APIException

See Also:

OrderService.discontinueOrder(org.openmrs.Order, org.openmrs.Concept, java.util.Date)

undiscontinueOrder

public Order undiscontinueOrder(Order order)
                         throws APIException

Description copied from interface: OrderService

Un-discontinue order record. Reverse a previous call to OrderService.discontinueOrder(Order, Concept, Date)

Specified by:

undiscontinueOrder in interface OrderService

Parameters:

order - order to be un-discontinued

Returns:

The Order that was undiscontinued

Throws:

APIException

See Also:

OrderService.undiscontinueOrder(org.openmrs.Order)

saveOrderType

public OrderType saveOrderType(OrderType orderType)
                        throws APIException

Description copied from interface: OrderService

Save or update the given orderType in the database

Specified by:

saveOrderType in interface OrderService

Parameters:

orderType - The OrderType to save in the database

Returns:

the freshly saved OrderType

Throws:

APIException

See Also:

OrderService.saveOrderType(org.openmrs.OrderType)

createOrderType

@Deprecated
public void createOrderType(OrderType orderType)
                                 throws APIException

Deprecated.

Specified by:

createOrderType in interface OrderService

Throws:

APIException

See Also:

OrderService.createOrderType(org.openmrs.OrderType)

updateOrderType

@Deprecated
public void updateOrderType(OrderType orderType)
                                 throws APIException

Deprecated.

Specified by:

updateOrderType in interface OrderService

Throws:

APIException

See Also:

OrderService.updateOrderType(org.openmrs.OrderType)

deleteOrderType

@Deprecated
public void deleteOrderType(OrderType orderType)
                                 throws APIException

Deprecated.

Specified by:

deleteOrderType in interface OrderService

Throws:

APIException

See Also:

OrderService.deleteOrderType(org.openmrs.OrderType)

retireOrderType

public OrderType retireOrderType(OrderType orderType,
                                 String reason)
                          throws APIException

Description copied from interface: OrderService

This method essentially takes the given orderType out of active use in OpenMRS. All references to this order type will remain in place. Future use of this order type are discouraged.

Specified by:

retireOrderType in interface OrderService

Parameters:

orderType - the order type to retired

reason - The reason this order type is being taken our of commission.

Returns:

the retired order type

Throws:

APIException

See Also:

OrderService.retireOrderType(OrderType, String)

unretireOrderType

public OrderType unretireOrderType(OrderType orderType)
                            throws APIException

Description copied from interface: OrderService

This will bring back a previously decommissioned OrderType

Specified by:

unretireOrderType in interface OrderService

Parameters:

orderType - the order type to unretire

Returns:

the retired order type

Throws:

APIException

See Also:

OrderService.unretireOrderType(org.openmrs.OrderType)

purgeOrderType

public void purgeOrderType(OrderType orderType)
                    throws APIException

Description copied from interface: OrderService

Completely delete the order type from the system. If data has been stored using this orderType, an exception will be thrown. In that case, consider using the #retiredOrderType(OrderType, String) method

Specified by:

purgeOrderType in interface OrderService

Throws:

APIException

See Also:

OrderService.purgeOrderType(org.openmrs.OrderType)

createOrdersAndEncounter

public void createOrdersAndEncounter(Patient p,
                                     Collection<Order> orders)
                              throws APIException

TODO: Refactor, generalize, or remove this method

Specified by:

createOrdersAndEncounter in interface OrderService

Parameters:

p - the patient to add Orders to

orders - The Orders to add to the Patient (and to the makeshift Encounter)

Throws:

APIException - if there is no User with username Unknown or no Location with name Unknown or Unknown Location, or if there's no encounter type with name 'Regimen Change'

See Also:

OrderService.createOrdersAndEncounter(org.openmrs.Patient, java.util.Collection)

getOrder

public Order getOrder(Integer orderId)
               throws APIException

Description copied from interface: OrderService

Get order by internal primary key identifier

Specified by:

getOrder in interface OrderService

Parameters:

orderId - internal order identifier

Returns:

order with given internal identifier

Throws:

APIException

See Also:

OrderService.getOrder(java.lang.Integer)

getDrugOrder

@Deprecated
public DrugOrder getDrugOrder(Integer drugOrderId)
                                   throws APIException

Deprecated.

Specified by:

getDrugOrder in interface OrderService

Throws:

APIException

See Also:

OrderService.getDrugOrder(java.lang.Integer)

getOrder

public <o extends Order> o getOrder(Integer orderId,
                                    Class<o> orderClassType)
                             throws APIException

Description copied from interface: OrderService

Gets the order with the associated order id

Specified by:

getOrder in interface OrderService

Type Parameters:

o - An Order type. Currently only org.openmrs.Order or org.openmrs.DrugOrder

Parameters:

orderId - the primary key of the Order

orderClassType - The class of Order to fetch (Currently only org.openmrs.Order or org.openmrs.DrugOrder)

Returns:

The Order in the system corresponding to given primary key id

Throws:

APIException

See Also:

OrderService.getOrder(java.lang.Integer, java.lang.Class)

getOrders

@Deprecated
public List<Order> getOrders()
                                  throws APIException

Deprecated. This is a dumb method

Specified by:

getOrders in interface OrderService

Throws:

APIException

getDrugOrders

@Deprecated
public List<DrugOrder> getDrugOrders()
                                          throws APIException

Deprecated. This is a dumb method

Specified by:

getDrugOrders in interface OrderService

Throws:

APIException

getOrders

public <Ord extends Order> List<Ord> getOrders(Class<Ord> orderClassType,
                                               List<Patient> patients,
                                               List<Concept> concepts,
                                               OrderService.ORDER_STATUS status,
                                               List<User> orderers,
                                               List<Encounter> encounters,
                                               List<OrderType> orderTypes)

Description copied from interface: OrderService

This searches for orders given the parameters. Most arguments are optional (nullable). If multiple arguments are given, the returned orders will match on all arguments.

Specified by:

getOrders in interface OrderService

Parameters:

orderClassType - The type of Order to get (currently only options are Order and DrugOrder)

patients - The patients to get orders for

concepts - The concepts in order.getConcept to get orders for

status - The ORDER_STATUS of the orders for its patient

orderers - The users/orderers of the

encounters - The encounters that the orders are assigned to

orderTypes - The OrderTypes to match on

Returns:

list of Orders matching the parameters

See Also:

OrderService.getOrders(java.lang.Class, java.util.List, java.util.List, org.openmrs.api.OrderService.ORDER_STATUS, java.util.List, java.util.List, java.util.List)

getOrdersByUser

public List<Order> getOrdersByUser(User user)
                            throws APIException

Description copied from interface: OrderService

Get all orders by the User that is marked as their orderer

Specified by:

getOrdersByUser in interface OrderService

Returns:

orders list

Throws:

APIException

See Also:

OrderService.getOrdersByUser(org.openmrs.User)

getOrdersByPatient

public List<Order> getOrdersByPatient(Patient patient)
                               throws APIException

Description copied from interface: OrderService

Get all orders by Patient

Specified by:

getOrdersByPatient in interface OrderService

Returns:

orders list

Throws:

APIException

See Also:

OrderService.getOrdersByPatient(org.openmrs.Patient)

getDrugOrdersByPatient

@Deprecated
public List<DrugOrder> getDrugOrdersByPatient(Patient patient,
                                                          int whatToShow)

Deprecated.

Specified by:

getDrugOrdersByPatient in interface OrderService

See Also:

OrderService.getDrugOrdersByPatient(org.openmrs.Patient, int)

getDrugOrdersByPatient

@Deprecated
public List<DrugOrder> getDrugOrdersByPatient(Patient patient,
                                                          int whatToShow,
                                                          boolean includeVoided)

Deprecated.

Specified by:

getDrugOrdersByPatient in interface OrderService

See Also:

OrderService.getDrugOrdersByPatient(org.openmrs.Patient, int, boolean)

getDrugOrdersByPatient

public List<DrugOrder> getDrugOrdersByPatient(Patient patient,
                                              OrderService.ORDER_STATUS orderStatus,
                                              boolean includeVoided)

Description copied from interface: OrderService

Get drug orders for a given patient

Specified by:

getDrugOrdersByPatient in interface OrderService

Parameters:

patient - the owning Patient of the returned orders

orderStatus - the status of the orders returned

includeVoided - true/false whether or not to include voided drug orders

Returns:

List of drug orders for the given patient

See Also:

OrderService.getDrugOrdersByPatient(org.openmrs.Patient, org.openmrs.api.OrderService.ORDER_STATUS, boolean)

getDrugOrdersByPatient

public List<DrugOrder> getDrugOrdersByPatient(Patient patient,
                                              OrderService.ORDER_STATUS orderStatus)

Description copied from interface: OrderService

Get drug orders for a given patient, not including voided orders

Specified by:

getDrugOrdersByPatient in interface OrderService

Returns:

List of drug orders, for the given patient, not including voided orders

See Also:

OrderService.getDrugOrdersByPatient(org.openmrs.Patient, org.openmrs.api.OrderService.ORDER_STATUS)

getOrderTypes

@Deprecated
public List<OrderType> getOrderTypes()
                                          throws APIException

Deprecated.

Description copied from interface: OrderService

Get all order types

Specified by:

getOrderTypes in interface OrderService

Returns:

order types list

Throws:

APIException

See Also:

OrderService.getOrderTypes()

getAllOrderTypes

public List<OrderType> getAllOrderTypes()
                                 throws APIException

Description copied from interface: OrderService

Get all order types, including retired ones

Specified by:

getAllOrderTypes in interface OrderService

Returns:

order types list

Throws:

APIException

See Also:

OrderService.getAllOrderTypes()

getAllOrderTypes

public List<OrderType> getAllOrderTypes(boolean includeRetired)
                                 throws APIException

Description copied from interface: OrderService

Get all order types, only showing ones not marked as retired if includeRetired is true

Specified by:

getAllOrderTypes in interface OrderService

Parameters:

includeRetired - true/false whether to include retired orderTypes in this list

Returns:

order types list

Throws:

APIException

See Also:

OrderService.getAllOrderTypes(boolean)

getOrderType

public OrderType getOrderType(Integer orderTypeId)
                       throws APIException

Description copied from interface: OrderService

Get orderType by internal identifier

Specified by:

getOrderType in interface OrderService

Returns:

orderType with given internal identifier

Throws:

APIException

See Also:

OrderService.getOrderType(java.lang.Integer)

getDrugOrdersByPatient

public List<DrugOrder> getDrugOrdersByPatient(Patient patient)
                                       throws APIException

Description copied from interface: OrderService

Get all orders for the given patient

Specified by:

getDrugOrdersByPatient in interface OrderService

Returns:

orders list

Throws:

APIException

See Also:

OrderService.getDrugOrdersByPatient(org.openmrs.Patient)

getStandardRegimens

public List<RegimenSuggestion> getStandardRegimens()

Description copied from interface: OrderService

The standard regimens are currently stored in the application context file. See xml elements after the "STANDARD REGIMENS" comment in the web spring servlet: /web/WEB-INF/openmrs-servlet.xml (These really should be in the non-web spring app context: /metadata/api/spring/applicationContext.xml)

Specified by:

getStandardRegimens in interface OrderService

Returns:

list of RegimenSuggestion objects that have been predefined

See Also:

OrderService.getStandardRegimens()

getDrugSetsByConcepts

@Deprecated
public Map<Concept,List<DrugOrder>> getDrugSetsByConcepts(List<DrugOrder> drugOrders,
                                                                      List<Concept> drugSets)
                                                               throws APIException

Deprecated. use OrderUtil.getDrugSetsByConcepts(List, List)

Specified by:

getDrugSetsByConcepts in interface OrderService

Throws:

APIException

See Also:

OrderService.getDrugSetsByConcepts(java.util.List, java.util.List)

getDrugSetsByDrugSetIdList

@Deprecated
public Map<String,List<DrugOrder>> getDrugSetsByDrugSetIdList(List<DrugOrder> orderList,
                                                                          String drugSetIdList,
                                                                          String delimiter)

Deprecated. use OrderUtil.getDrugSetsByDrugSetIdList(List, String, String)

Specified by:

getDrugSetsByDrugSetIdList in interface OrderService

See Also:

OrderService.getDrugSetsByDrugSetIdList(java.util.List, java.lang.String, java.lang.String)

getDrugSetHeadersByDrugSetIdList

@Deprecated
public Map<String,String> getDrugSetHeadersByDrugSetIdList(String drugSetIds)

Deprecated. use OrderUtil.getDrugSetHeadersByDrugSetIdList(String)

Specified by:

getDrugSetHeadersByDrugSetIdList in interface OrderService

See Also:

OrderService.getDrugSetHeadersByDrugSetIdList(java.lang.String)

discontinueDrugSet

@Deprecated
public void discontinueDrugSet(Patient patient,
                                           String drugSetId,
                                           Concept discontinueReason,
                                           Date discontinueDate)

Deprecated. use OrderUtil.discontinueDrugSet(Patient, String, Concept, Date)

Specified by:

discontinueDrugSet in interface OrderService

See Also:

OrderService.discontinueDrugSet(org.openmrs.Patient, java.lang.String, org.openmrs.Concept, java.util.Date)

voidDrugSet

@Deprecated
public void voidDrugSet(Patient patient,
                                    String drugSetId,
                                    String voidReason,
                                    int whatToVoid)

Deprecated. use OrderUtil.voidDrugSet(Patient, String, String, org.openmrs.api.OrderService.ORDER_STATUS)

Specified by:

voidDrugSet in interface OrderService

See Also:

OrderService.voidDrugSet(Patient, String, String, int)

discontinueAllOrders

@Deprecated
public void discontinueAllOrders(Patient patient,
                                             Concept discontinueReason,
                                             Date discontinueDate)

Deprecated. use OrderUtil.discontinueAllOrders(Patient, Concept, Date)

Specified by:

discontinueAllOrders in interface OrderService

See Also:

OrderService.discontinueAllOrders(org.openmrs.Patient, org.openmrs.Concept, java.util.Date)

getOrderByUuid

public Order getOrderByUuid(String uuid)
                     throws APIException

Description copied from interface: OrderService

Get Order by its UUID

Specified by:

getOrderByUuid in interface OrderService

Returns:

Throws:

APIException

See Also:

OrderService.getOrderByUuid(java.lang.String)

getOrderTypeByUuid

public OrderType getOrderTypeByUuid(String uuid)
                             throws APIException

Description copied from interface: OrderService

Get OrderType by its UUID

Specified by:

getOrderTypeByUuid in interface OrderService

Returns:

Throws:

APIException

See Also:

OrderService.getOrderTypeByUuid(java.lang.String)

getOrdersByEncounter

public List<Order> getOrdersByEncounter(Encounter encounter)

Description copied from interface: OrderService

Gets all orders contained in an encounter

Specified by:

getOrdersByEncounter in interface OrderService

Parameters:

encounter - the encounter in which to search for orders

Returns:

orders contained in the given encounter

See Also:

OrderService.getOrdersByEncounter(org.openmrs.Encounter)