org.openmrs.api.db.hibernate

Class HibernateOrderDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateOrderDAO

All Implemented Interfaces:

OrderDAO

public class HibernateOrderDAO
extends 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

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)
void	deleteOrderAttributeType(OrderAttributeType orderAttributeType)
void	deleteOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
List<Order>	getActiveOrders(Patient patient, List<OrderType> orderTypes, CareSetting careSetting, Date asOfDate)
List<Order>	getActiveOrders(Patient patient, Visit visit, List<OrderType> orderTypes, CareSetting careSetting, Date asOfDate)
List<OrderAttributeType>	getAllOrderAttributeTypes()
List<OrderGroupAttributeType>	getAllOrderGroupAttributeTypes()
CareSetting	getCareSetting(Integer careSettingId) Get care setting by type
CareSetting	getCareSettingByName(String name)
CareSetting	getCareSettingByUuid(String uuid)
List<CareSetting>	getCareSettings(boolean includeRetired)
Order	getDiscontinuationOrder(Order order)
Long	getNextOrderNumberSeedSequenceValue() Gets the next available order number seed
Order	getOrder(Integer orderId)
OrderAttribute	getOrderAttributeByUuid(String uuid)
OrderAttributeType	getOrderAttributeTypeById(Integer orderAttributeTypeId)
OrderAttributeType	getOrderAttributeTypeByName(String name)
OrderAttributeType	getOrderAttributeTypeByUuid(String uuid)
Order	getOrderByOrderNumber(String orderNumber)
Order	getOrderByUuid(String uuid)
List<OrderFrequency>	getOrderFrequencies(boolean includeRetired)
List<OrderFrequency>	getOrderFrequencies(String searchPhrase, Locale locale, boolean exactLocale, boolean includeRetired)
OrderFrequency	getOrderFrequency(Integer orderFrequencyId)
OrderFrequency	getOrderFrequencyByConcept(Concept concept)
OrderFrequency	getOrderFrequencyByUuid(String uuid)
List<Object[]>	getOrderFromDatabase(Order order, boolean isOrderADrugOrder) Get the fresh order from the database
OrderGroupAttribute	getOrderGroupAttributeByUuid(String uuid)
OrderGroupAttributeType	getOrderGroupAttributeType(Integer orderGroupAttributeTypeId)
OrderGroupAttributeType	getOrderGroupAttributeTypeByName(String name)
OrderGroupAttributeType	getOrderGroupAttributeTypeByUuid(String uuid)
OrderGroup	getOrderGroupById(Integer orderGroupId)
OrderGroup	getOrderGroupByUuid(String uuid)
List<OrderGroup>	getOrderGroupsByEncounter(Encounter encounter)
List<OrderGroup>	getOrderGroupsByPatient(Patient patient)
List<Order>	getOrders(OrderSearchCriteria searchCriteria)
List<Order>	getOrders(OrderType orderType, List<Patient> patients, List<Concept> concepts, List<User> orderers, List<Encounter> encounters) This searches for orders given the parameters.
List<Order>	getOrders(Patient patient, CareSetting careSetting, List<OrderType> orderTypes, boolean includeVoided, boolean includeDiscontinuationOrders)
List<Order>	getOrders(Patient patient, Visit visit, CareSetting careSetting, List<OrderType> orderTypes, boolean includeVoided, boolean includeDiscontinuationOrders)
List<OrderType>	getOrderSubtypes(OrderType orderType, boolean includeRetired)
OrderType	getOrderType(Integer orderTypeId)
OrderType	getOrderTypeByConceptClass(ConceptClass conceptClass)
OrderType	getOrderTypeByName(String orderTypeName)
OrderType	getOrderTypeByUuid(String uuid)
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)
OrderAttributeType	saveOrderAttributeType(OrderAttributeType orderAttributeType)
OrderFrequency	saveOrderFrequency(OrderFrequency orderFrequency)
OrderGroup	saveOrderGroup(OrderGroup orderGroup) Saves an orderGroup to the database
OrderGroupAttributeType	saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
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

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(Integer orderId)
               throws DAOException

Specified by:

getOrder in interface OrderDAO

Throws:

DAOException

See Also:

OrderService.getOrder(java.lang.Integer)

getOrders

public List<Order> getOrders(OrderType orderType,
                             List<Patient> patients,
                             List<Concept> concepts,
                             List<User> orderers,
                             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 List<Order> getOrders(OrderSearchCriteria searchCriteria)

Specified by:

getOrders in interface OrderDAO

See Also:

OrderDAO.getOrders(OrderSearchCriteria)

getOrders

public List<Order> getOrders(Patient patient,
                             CareSetting careSetting,
                             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)

getOrders

public List<Order> getOrders(Patient patient,
                             Visit visit,
                             CareSetting careSetting,
                             List<OrderType> orderTypes,
                             boolean includeVoided,
                             boolean includeDiscontinuationOrders)

Specified by:

getOrders in interface OrderDAO

See Also:

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

getOrderByUuid

public Order getOrderByUuid(String uuid)

Specified by:

getOrderByUuid in interface OrderDAO

Returns:

order or null

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 List<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

saveOrderGroup

public OrderGroup saveOrderGroup(OrderGroup orderGroup)
                          throws DAOException

Description copied from interface: OrderDAO

Saves an orderGroup to the database

Specified by:

saveOrderGroup in interface OrderDAO

Returns:

an orderGroup

Throws:

DAOException

See Also:

OrderDAO.saveOrderGroup(OrderGroup)

getOrderGroupByUuid

public OrderGroup getOrderGroupByUuid(String uuid)
                               throws DAOException

Specified by:

getOrderGroupByUuid in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupByUuid(String), OrderService.getOrderGroupByUuid(String)

getOrderGroupById

public OrderGroup getOrderGroupById(Integer orderGroupId)
                             throws DAOException

Specified by:

getOrderGroupById in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupById(Integer), OrderService.getOrderGroup(Integer)

deleteObsThatReference

public void deleteObsThatReference(Order order)

Delete Obs that references (deleted) Order

Specified by:

deleteObsThatReference in interface OrderDAO

getOrderByOrderNumber

public Order getOrderByOrderNumber(String orderNumber)

Specified by:

getOrderByOrderNumber in interface OrderDAO

See Also:

OrderDAO.getOrderByOrderNumber(java.lang.String)

getNextOrderNumberSeedSequenceValue

public 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 List<Order> getActiveOrders(Patient patient,
                                   List<OrderType> orderTypes,
                                   CareSetting careSetting,
                                   Date asOfDate)

Specified by:

getActiveOrders in interface OrderDAO

See Also:

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

getActiveOrders

public List<Order> getActiveOrders(Patient patient,
                                   Visit visit,
                                   List<OrderType> orderTypes,
                                   CareSetting careSetting,
                                   Date asOfDate)

Specified by:

getActiveOrders in interface OrderDAO

See Also:

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

getCareSetting

public CareSetting getCareSetting(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(String uuid)

Specified by:

getCareSettingByUuid in interface OrderDAO

See Also:

OrderDAO.getCareSettingByUuid(String)

getCareSettingByName

public CareSetting getCareSettingByName(String name)

Specified by:

getCareSettingByName in interface OrderDAO

See Also:

OrderDAO.getCareSettingByName(String)

getCareSettings

public List<CareSetting> getCareSettings(boolean includeRetired)

Specified by:

getCareSettings in interface OrderDAO

See Also:

OrderDAO.getCareSettings(boolean)

getOrderTypeByName

public OrderType getOrderTypeByName(String orderTypeName)

Specified by:

getOrderTypeByName in interface OrderDAO

See Also:

OrderDAO.getOrderTypeByName(java.lang.String)

getOrderFrequency

public OrderFrequency getOrderFrequency(Integer orderFrequencyId)

Specified by:

getOrderFrequency in interface OrderDAO

See Also:

OrderDAO.getOrderFrequency(java.lang.Integer)

getOrderFrequencyByUuid

public OrderFrequency getOrderFrequencyByUuid(String uuid)

Specified by:

getOrderFrequencyByUuid in interface OrderDAO

See Also:

OrderDAO.getOrderFrequencyByUuid(java.lang.String)

getOrderFrequencies

public List<OrderFrequency> getOrderFrequencies(boolean includeRetired)

Specified by:

getOrderFrequencies in interface OrderDAO

See Also:

OrderDAO.getOrderFrequencies(boolean)

getOrderFrequencies

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

Specified by:

getOrderFrequencies in interface OrderDAO

See Also:

OrderDAO.getOrderFrequencies(String, java.util.Locale, boolean, boolean)

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(Integer orderTypeId)

Specified by:

getOrderType in interface OrderDAO

See Also:

OrderDAO.getOrderType(Integer)

getOrderTypeByUuid

public OrderType getOrderTypeByUuid(String uuid)

Specified by:

getOrderTypeByUuid in interface OrderDAO

See Also:

OrderDAO.getOrderTypeByUuid(String)

getOrderTypes

public List<OrderType> getOrderTypes(boolean includeRetired)

Specified by:

getOrderTypes in interface OrderDAO

See Also:

OrderDAO.getOrderTypes(boolean)

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 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

getOrderGroupsByPatient

public List<OrderGroup> getOrderGroupsByPatient(Patient patient)

Specified by:

getOrderGroupsByPatient in interface OrderDAO

See Also:

OrderDAO.getOrderGroupsByPatient(Patient)

getOrderGroupsByEncounter

public List<OrderGroup> getOrderGroupsByEncounter(Encounter encounter)

Specified by:

getOrderGroupsByEncounter in interface OrderDAO

See Also:

OrderDAO.getOrderGroupsByEncounter(Encounter)

getAllOrderGroupAttributeTypes

public List<OrderGroupAttributeType> getAllOrderGroupAttributeTypes()

Specified by:

getAllOrderGroupAttributeTypes in interface OrderDAO

See Also:

OrderDAO.getAllOrderGroupAttributeTypes()

getOrderGroupAttributeType

public OrderGroupAttributeType getOrderGroupAttributeType(Integer orderGroupAttributeTypeId)
                                                   throws DAOException

Specified by:

getOrderGroupAttributeType in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupAttributeType(java.lang.Integer)

getOrderGroupAttributeTypeByUuid

public OrderGroupAttributeType getOrderGroupAttributeTypeByUuid(String uuid)
                                                         throws DAOException

Specified by:

getOrderGroupAttributeTypeByUuid in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupAttributeTypeByUuid(java.lang.String)

saveOrderGroupAttributeType

public OrderGroupAttributeType saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                    throws DAOException

Specified by:

saveOrderGroupAttributeType in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.saveOrderGroupAttributeType(org.openmrs.OrderGroupAttributeType)

deleteOrderGroupAttributeType

public void deleteOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                   throws DAOException

Specified by:

deleteOrderGroupAttributeType in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.deleteOrderGroupAttributeType(org.openmrs.OrderGroupAttributeType)

getOrderGroupAttributeByUuid

public OrderGroupAttribute getOrderGroupAttributeByUuid(String uuid)
                                                 throws DAOException

Specified by:

getOrderGroupAttributeByUuid in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupAttributeByUuid(String)

getOrderGroupAttributeTypeByName

public OrderGroupAttributeType getOrderGroupAttributeTypeByName(String name)
                                                         throws DAOException

Specified by:

getOrderGroupAttributeTypeByName in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getOrderGroupAttributeTypeByName(String)

getOrderAttributeByUuid

public OrderAttribute getOrderAttributeByUuid(String uuid)
                                       throws DAOException

Specified by:

getOrderAttributeByUuid in interface OrderDAO

Parameters:

uuid - The uuid associated with the order attribute to retrieve.

Throws:

DAOException

See Also:

OrderDAO.getOrderAttributeByUuid(String)

getAllOrderAttributeTypes

public List<OrderAttributeType> getAllOrderAttributeTypes()
                                                   throws DAOException

Specified by:

getAllOrderAttributeTypes in interface OrderDAO

Throws:

DAOException

See Also:

OrderDAO.getAllOrderAttributeTypes()

getOrderAttributeTypeById

public OrderAttributeType getOrderAttributeTypeById(Integer orderAttributeTypeId)
                                             throws DAOException

Specified by:

getOrderAttributeTypeById in interface OrderDAO

Parameters:

orderAttributeTypeId - The orderAttributeTypeId for the order attribute type to retrieve.

Throws:

DAOException

See Also:

OrderDAO.getOrderAttributeTypeById(Integer)

getOrderAttributeTypeByUuid

public OrderAttributeType getOrderAttributeTypeByUuid(String uuid)
                                               throws DAOException

Specified by:

getOrderAttributeTypeByUuid in interface OrderDAO

Parameters:

uuid - The uuid associated with the order attribute type to retrieve

Throws:

DAOException

See Also:

OrderDAO.getOrderAttributeTypeByUuid(String)

saveOrderAttributeType

public OrderAttributeType saveOrderAttributeType(OrderAttributeType orderAttributeType)
                                          throws DAOException

Specified by:

saveOrderAttributeType in interface OrderDAO

Parameters:

orderAttributeType - The orderAttributeType to save

Throws:

DAOException

See Also:

OrderDAO.saveOrderAttributeType(OrderAttributeType)

deleteOrderAttributeType

public void deleteOrderAttributeType(OrderAttributeType orderAttributeType)
                              throws DAOException

Specified by:

deleteOrderAttributeType in interface OrderDAO

Parameters:

orderAttributeType - The orderAttributeType to retire

Throws:

DAOException

See Also:

org.openmrs.api.db.OrderDAO#purgeOrderAttributeType(OrderAttributeType)

getOrderAttributeTypeByName

public OrderAttributeType getOrderAttributeTypeByName(String name)
                                               throws DAOException

Specified by:

getOrderAttributeTypeByName in interface OrderDAO

Parameters:

name - The name of the order attribute type to retrieve

Throws:

DAOException

See Also:

OrderDAO.getOrderAttributeTypeByName(String)