org.openmrs.api.db.hibernate

Class HibernateOrderDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateOrderDAO

All Implemented Interfaces:

OrderDAO

public class HibernateOrderDAO
extends java.lang.Object
implements OrderDAO

This class should not be used directly. This is just a common implementation of the OrderDAO that is used by the OrderService. This class is injected by spring into the desired OrderService class. This injection is determined by the xml mappings and elements in the spring application context: /metadata/api/spring/applicationContext.xml.

The OrderService should be used for all Order related database manipulation.

See Also:

OrderService, OrderDAO

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HibernateOrderDAO()

Method Summary

Modifier and Type	Method and Description
void	deleteObsThatReference(Order order) Delete Obs that references (deleted) Order
void	deleteOrder(Order order)
java.util.List<Order>	getActiveOrders(Patient patient, java.util.List<OrderType> orderTypes, CareSetting careSetting, java.util.Date asOfDate)
CareSetting	getCareSetting(java.lang.Integer careSettingId) Get care setting by type
CareSetting	getCareSettingByName(java.lang.String name)
CareSetting	getCareSettingByUuid(java.lang.String uuid)
java.util.List<CareSetting>	getCareSettings(boolean includeRetired)
Order	getDiscontinuationOrder(Order order)
java.lang.Long	getNextOrderNumberSeedSequenceValue() Gets the next available order number seed
Order	getOrder(java.lang.Integer orderId)
Order	getOrderByOrderNumber(java.lang.String orderNumber)
Order	getOrderByUuid(java.lang.String uuid) Auto generated method comment
java.util.List<OrderFrequency>	getOrderFrequencies(boolean includeRetired)
java.util.List<OrderFrequency>	getOrderFrequencies(java.lang.String searchPhrase, java.util.Locale locale, boolean exactLocale, boolean includeRetired)
OrderFrequency	getOrderFrequency(java.lang.Integer orderFrequencyId)
OrderFrequency	getOrderFrequencyByConcept(Concept concept)
OrderFrequency	getOrderFrequencyByUuid(java.lang.String uuid)
java.util.List<java.util.List<java.lang.Object>>	getOrderFromDatabase(Order order, boolean isOrderADrugOrder) Get the fresh order from the database
java.util.List<Order>	getOrders(OrderType orderType, java.util.List<Patient> patients, java.util.List<Concept> concepts, java.util.List<User> orderers, java.util.List<Encounter> encounters) This searches for orders given the parameters.
java.util.List<Order>	getOrders(Patient patient, CareSetting careSetting, java.util.List<OrderType> orderTypes, boolean includeVoided, boolean includeDiscontinuationOrders)
java.util.List<OrderType>	getOrderSubtypes(OrderType orderType, boolean includeRetired)
OrderType	getOrderType(java.lang.Integer orderTypeId)
OrderType	getOrderTypeByConceptClass(ConceptClass conceptClass)
OrderType	getOrderTypeByName(java.lang.String orderTypeName)
OrderType	getOrderTypeByUuid(java.lang.String uuid)
java.util.List<OrderType>	getOrderTypes(boolean includeRetired)
Order	getRevisionOrder(Order order)
boolean	isOrderFrequencyInUse(OrderFrequency orderFrequency) Checks if an order frequency is being referenced by any order
boolean	isOrderTypeInUse(OrderType orderType) Check whether give order type is used by any order
void	purgeOrderFrequency(OrderFrequency orderFrequency)
void	purgeOrderType(OrderType orderType)
Order	saveOrder(Order order)
OrderFrequency	saveOrderFrequency(OrderFrequency orderFrequency)
OrderType	saveOrderType(OrderType orderType)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set session factory

Methods inherited from class java.lang.Object

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

Field Detail

log

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

Constructor Detail

HibernateOrderDAO

public HibernateOrderDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

saveOrder

public Order saveOrder(Order order)
                throws DAOException

Specified by:

saveOrder in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.saveOrder(org.openmrs.Order), OrderService.saveOrder(org.openmrs.Order, org.openmrs.api.OrderContext)

deleteOrder

public void deleteOrder(Order order)
                 throws DAOException

Specified by:

deleteOrder in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.deleteOrder(org.openmrs.Order), OrderService.purgeOrder(org.openmrs.Order)

getOrder

public Order getOrder(java.lang.Integer orderId)
               throws DAOException

Specified by:

getOrder in interface OrderDAO

Throws:

DAOException

See Also:

OrderService.getOrder(java.lang.Integer)

getOrders

public java.util.List<Order> getOrders(OrderType orderType,
                                       java.util.List<Patient> patients,
                                       java.util.List<Concept> concepts,
                                       java.util.List<User> orderers,
                                       java.util.List<Encounter> encounters)

Description copied from interface: OrderDAO

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. The orders are sorted by startDate with the latest coming first

Specified by:

getOrders in interface OrderDAO

Parameters:

orderType - The type of Order to get

patients - The patients to get orders for

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

orderers - The orderers to match on

encounters - The encounters that the orders are assigned to

Returns:

list of Orders matching the parameters

See Also:

OrderDAO.getOrders(org.openmrs.OrderType, java.util.List, java.util.List, java.util.List, java.util.List)

getOrders

public java.util.List<Order> getOrders(Patient patient,
                                       CareSetting careSetting,
                                       java.util.List<OrderType> orderTypes,
                                       boolean includeVoided,
                                       boolean includeDiscontinuationOrders)

Specified by:

getOrders in interface OrderDAO

See Also:

OrderDAO.getOrders(org.openmrs.Patient, org.openmrs.CareSetting, java.util.List, boolean, boolean)

getOrderByUuid

public Order getOrderByUuid(java.lang.String uuid)

Description copied from interface: OrderDAO

Auto generated method comment

Specified by:

getOrderByUuid in interface OrderDAO

Returns:

See Also:

OrderDAO.getOrderByUuid(java.lang.String)

getDiscontinuationOrder

public Order getDiscontinuationOrder(Order order)

Specified by:

getDiscontinuationOrder in interface OrderDAO

See Also:

OrderDAO.getRevisionOrder(org.openmrs.Order)

getRevisionOrder

public Order getRevisionOrder(Order order)
                       throws APIException

Specified by:

getRevisionOrder in interface OrderDAO

Throws:

APIException

See Also:

OrderService.getRevisionOrder(org.openmrs.Order)

getOrderFromDatabase

public java.util.List<java.util.List<java.lang.Object>> getOrderFromDatabase(Order order,
                                                                             boolean isOrderADrugOrder)
                                                                      throws APIException

Description copied from interface: OrderDAO

Get the fresh order from the database

Specified by:

getOrderFromDatabase in interface OrderDAO

Parameters:

order - the order to get from the database

isOrderADrugOrder - is the order a previous order

Returns:

a list of orders from the database

Throws:

APIException

deleteObsThatReference

public void deleteObsThatReference(Order order)

Delete Obs that references (deleted) Order

Specified by:

deleteObsThatReference in interface OrderDAO

getOrderByOrderNumber

public Order getOrderByOrderNumber(java.lang.String orderNumber)

Specified by:

getOrderByOrderNumber in interface OrderDAO

See Also:

OrderDAO.getOrderByOrderNumber(java.lang.String)

getNextOrderNumberSeedSequenceValue

public java.lang.Long getNextOrderNumberSeedSequenceValue()

Description copied from interface: OrderDAO

Gets the next available order number seed

Specified by:

getNextOrderNumberSeedSequenceValue in interface OrderDAO

Returns:

the order number seed

See Also:

OrderDAO.getNextOrderNumberSeedSequenceValue()

getActiveOrders

public java.util.List<Order> getActiveOrders(Patient patient,
                                             java.util.List<OrderType> orderTypes,
                                             CareSetting careSetting,
                                             java.util.Date asOfDate)

Specified by:

getActiveOrders in interface OrderDAO

See Also:

OrderDAO.getActiveOrders(org.openmrs.Patient, java.util.List, org.openmrs.CareSetting, java.util.Date)

getCareSetting

public CareSetting getCareSetting(java.lang.Integer careSettingId)

Description copied from interface: OrderDAO

Get care setting by type

Specified by:

getCareSetting in interface OrderDAO

Returns:

the care setting type

See Also:

OrderDAO.getCareSetting(Integer)

getCareSettingByUuid

public CareSetting getCareSettingByUuid(java.lang.String uuid)

Specified by:

getCareSettingByUuid in interface OrderDAO

See Also:

OrderDAO.getCareSettingByUuid(String)

getCareSettingByName

public CareSetting getCareSettingByName(java.lang.String name)

Specified by:

getCareSettingByName in interface OrderDAO

See Also:

OrderDAO.getCareSettingByName(String)

getCareSettings

public java.util.List<CareSetting> getCareSettings(boolean includeRetired)

Specified by:

getCareSettings in interface OrderDAO

See Also:

OrderDAO.getCareSettings(boolean)

getOrderTypeByName

public OrderType getOrderTypeByName(java.lang.String orderTypeName)

Specified by:

getOrderTypeByName in interface OrderDAO

getOrderFrequency

public OrderFrequency getOrderFrequency(java.lang.Integer orderFrequencyId)

Specified by:

getOrderFrequency in interface OrderDAO

getOrderFrequencyByUuid

public OrderFrequency getOrderFrequencyByUuid(java.lang.String uuid)

Specified by:

getOrderFrequencyByUuid in interface OrderDAO

getOrderFrequencies

public java.util.List<OrderFrequency> getOrderFrequencies(boolean includeRetired)

Specified by:

getOrderFrequencies in interface OrderDAO

getOrderFrequencies

public java.util.List<OrderFrequency> getOrderFrequencies(java.lang.String searchPhrase,
                                                          java.util.Locale locale,
                                                          boolean exactLocale,
                                                          boolean includeRetired)

Specified by:

getOrderFrequencies in interface OrderDAO

saveOrderFrequency

public OrderFrequency saveOrderFrequency(OrderFrequency orderFrequency)

Specified by:

saveOrderFrequency in interface OrderDAO

See Also:

OrderDAO.saveOrderFrequency(org.openmrs.OrderFrequency)

purgeOrderFrequency

public void purgeOrderFrequency(OrderFrequency orderFrequency)

Specified by:

purgeOrderFrequency in interface OrderDAO

See Also:

OrderDAO.purgeOrderFrequency(org.openmrs.OrderFrequency)

isOrderFrequencyInUse

public boolean isOrderFrequencyInUse(OrderFrequency orderFrequency)

Description copied from interface: OrderDAO

Checks if an order frequency is being referenced by any order

Specified by:

isOrderFrequencyInUse in interface OrderDAO

Parameters:

orderFrequency - the order frequency

Returns:

true if in use, else false

See Also:

OrderDAO.isOrderFrequencyInUse(org.openmrs.OrderFrequency)

getOrderFrequencyByConcept

public OrderFrequency getOrderFrequencyByConcept(Concept concept)

Specified by:

getOrderFrequencyByConcept in interface OrderDAO

See Also:

OrderDAO.getOrderFrequencyByConcept(org.openmrs.Concept)

getOrderType

public OrderType getOrderType(java.lang.Integer orderTypeId)

Specified by:

getOrderType in interface OrderDAO

getOrderTypeByUuid

public OrderType getOrderTypeByUuid(java.lang.String uuid)

Specified by:

getOrderTypeByUuid in interface OrderDAO

getOrderTypes

public java.util.List<OrderType> getOrderTypes(boolean includeRetired)

Specified by:

getOrderTypes in interface OrderDAO

getOrderTypeByConceptClass

public OrderType getOrderTypeByConceptClass(ConceptClass conceptClass)

Specified by:

getOrderTypeByConceptClass in interface OrderDAO

See Also:

OrderDAO.getOrderTypeByConceptClass(org.openmrs.ConceptClass)

saveOrderType

public OrderType saveOrderType(OrderType orderType)

Specified by:

saveOrderType in interface OrderDAO

See Also:

OrderService.saveOrderType(org.openmrs.OrderType)

purgeOrderType

public void purgeOrderType(OrderType orderType)

Specified by:

purgeOrderType in interface OrderDAO

See Also:

OrderService.purgeOrderType(org.openmrs.OrderType)

getOrderSubtypes

public java.util.List<OrderType> getOrderSubtypes(OrderType orderType,
                                                  boolean includeRetired)

Specified by:

getOrderSubtypes in interface OrderDAO

See Also:

OrderService.getSubtypes(org.openmrs.OrderType, boolean)

isOrderTypeInUse

public boolean isOrderTypeInUse(OrderType orderType)

Description copied from interface: OrderDAO

Check whether give order type is used by any order

Specified by:

isOrderTypeInUse in interface OrderDAO

Parameters:

orderType - the order type to check the usage

Returns:

true if used else false