org.openmrs.api.db

Interface OrderDAO

All Known Implementing Classes:

HibernateOrderDAO

public interface OrderDAO

Order-related database functions

This class should never be used directly. It should only be used through the OrderService

See Also:

OrderService

Method Summary

Modifier and Type	Method and Description
void	deleteObsThatReference(Order order) Delete Obs that references an 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 orderSearchCriteria)
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)

Method Detail

saveOrder

Order saveOrder(Order order)
         throws DAOException

Throws:

DAOException

See Also:

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

deleteOrder

void deleteOrder(Order order)
          throws DAOException

Throws:

DAOException

See Also:

OrderService.purgeOrder(Order)

getOrder

Order getOrder(Integer orderId)
        throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrder(Integer)

getOrders

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

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

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

getOrders

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

See Also:

OrderService.getOrders(org.openmrs.Patient, org.openmrs.CareSetting, org.openmrs.OrderType, boolean)

getOrders

List<Order> getOrders(OrderSearchCriteria orderSearchCriteria)

See Also:

OrderService.getOrders(OrderSearchCriteria)

getOrderByUuid

Order getOrderByUuid(String uuid)

Parameters:

uuid -

Returns:

order or null

deleteObsThatReference

void deleteObsThatReference(Order order)

Delete Obs that references an order

getOrderByOrderNumber

Order getOrderByOrderNumber(String orderNumber)

See Also:

OrderService.getOrderByOrderNumber(java.lang.String)

getNextOrderNumberSeedSequenceValue

Long getNextOrderNumberSeedSequenceValue()

Gets the next available order number seed

Returns:

the order number seed

getActiveOrders

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

See Also:

OrderService.getActiveOrders(org.openmrs.Patient, org.openmrs.OrderType, org.openmrs.CareSetting, java.util.Date)

getCareSetting

CareSetting getCareSetting(Integer careSettingId)

Get care setting by type

Parameters:

careSettingId -

Returns:

the care setting type

getCareSettingByUuid

CareSetting getCareSettingByUuid(String uuid)

See Also:

OrderService.getCareSettingByUuid(String)

getCareSettingByName

CareSetting getCareSettingByName(String name)

See Also:

OrderService.getCareSettingByName(String)

getCareSettings

List<CareSetting> getCareSettings(boolean includeRetired)

See Also:

OrderService.getCareSettings(boolean)

getOrderTypeByName

OrderType getOrderTypeByName(String orderTypeName)

See Also:

OrderService.getOrderTypeByName(String)

getOrderFrequency

OrderFrequency getOrderFrequency(Integer orderFrequencyId)

See Also:

OrderService.getOrderFrequency(java.lang.Integer)

getOrderFrequencyByUuid

OrderFrequency getOrderFrequencyByUuid(String uuid)

See Also:

OrderService.getOrderFrequencyByUuid(java.lang.String)

getOrderFrequencies

List<OrderFrequency> getOrderFrequencies(boolean includeRetired)

See Also:

OrderService.getOrderFrequencies(boolean)

getOrderFrequencies

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

See Also:

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

saveOrderFrequency

OrderFrequency saveOrderFrequency(OrderFrequency orderFrequency)

See Also:

OrderService.saveOrderFrequency(org.openmrs.OrderFrequency)

purgeOrderFrequency

void purgeOrderFrequency(OrderFrequency orderFrequency)

See Also:

OrderService.purgeOrderFrequency(org.openmrs.OrderFrequency)

isOrderFrequencyInUse

boolean isOrderFrequencyInUse(OrderFrequency orderFrequency)

Checks if an order frequency is being referenced by any order

Parameters:

orderFrequency - the order frequency

Returns:

true if in use, else false

getOrderFrequencyByConcept

OrderFrequency getOrderFrequencyByConcept(Concept concept)

See Also:

OrderService.getOrderFrequencyByConcept(org.openmrs.Concept)

getOrderType

OrderType getOrderType(Integer orderTypeId)

See Also:

OrderService.getOrderType(java.lang.Integer)

getOrderTypeByUuid

OrderType getOrderTypeByUuid(String uuid)

See Also:

OrderService.getOrderTypeByUuid(java.lang.String)

getOrderTypes

List<OrderType> getOrderTypes(boolean includeRetired)

See Also:

OrderService.getOrderTypes(boolean)

getOrderTypeByConceptClass

OrderType getOrderTypeByConceptClass(ConceptClass conceptClass)

See Also:

OrderService.getOrderTypeByConceptClass(org.openmrs.ConceptClass)

saveOrderType

OrderType saveOrderType(OrderType orderType)

See Also:

OrderService.saveOrderType(org.openmrs.OrderType)

purgeOrderType

void purgeOrderType(OrderType orderType)

See Also:

OrderService.purgeOrderType(org.openmrs.OrderType)

getOrderSubtypes

List<OrderType> getOrderSubtypes(OrderType orderType,
                                 boolean includeRetired)

See Also:

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

isOrderTypeInUse

boolean isOrderTypeInUse(OrderType orderType)

Check whether give order type is used by any order

Parameters:

orderType - the order type to check the usage

Returns:

true if used else false

getDiscontinuationOrder

Order getDiscontinuationOrder(Order order)

See Also:

OrderService.getDiscontinuationOrder(Order)

getRevisionOrder

Order getRevisionOrder(Order order)
                throws APIException

Throws:

APIException

See Also:

OrderService.getRevisionOrder(org.openmrs.Order)

getOrderFromDatabase

List<Object[]> getOrderFromDatabase(Order order,
                                    boolean isOrderADrugOrder)
                             throws APIException

Get the fresh order from the database

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

OrderGroup saveOrderGroup(OrderGroup orderGroup)
                   throws DAOException

Saves an orderGroup to the database

Parameters:

orderGroup -

Returns:

an orderGroup

Throws:

DAOException

getOrderGroupByUuid

OrderGroup getOrderGroupByUuid(String uuid)
                        throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupByUuid(String)

getOrderGroupById

OrderGroup getOrderGroupById(Integer orderGroupId)
                      throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroup(Integer)

getOrderGroupsByPatient

List<OrderGroup> getOrderGroupsByPatient(Patient patient)
                                  throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupsByPatient(Patient)

getOrderGroupsByEncounter

List<OrderGroup> getOrderGroupsByEncounter(Encounter encounter)
                                    throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupsByEncounter(Encounter)

getOrderGroupAttributeByUuid

OrderGroupAttribute getOrderGroupAttributeByUuid(String uuid)
                                          throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupAttributeByUuid(String)

getAllOrderGroupAttributeTypes

List<OrderGroupAttributeType> getAllOrderGroupAttributeTypes()
                                                      throws DAOException

Throws:

DAOException

See Also:

OrderService.getAllOrderGroupAttributeTypes()

getOrderGroupAttributeType

OrderGroupAttributeType getOrderGroupAttributeType(Integer orderGroupAttributeTypeId)
                                            throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupAttributeType(Integer)

getOrderGroupAttributeTypeByUuid

OrderGroupAttributeType getOrderGroupAttributeTypeByUuid(String uuid)
                                                  throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupAttributeTypeByUuid(String)

saveOrderGroupAttributeType

OrderGroupAttributeType saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                             throws DAOException

Throws:

DAOException

See Also:

OrderService.saveOrderGroupAttributeType(OrderGroupAttributeType)

deleteOrderGroupAttributeType

void deleteOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                            throws DAOException

Throws:

DAOException

See Also:

OrderService.purgeOrderGroupAttributeType(OrderGroupAttributeType)

getOrderGroupAttributeTypeByName

OrderGroupAttributeType getOrderGroupAttributeTypeByName(String name)
                                                  throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderGroupAttributeTypeByName(String)

getOrderAttributeByUuid

OrderAttribute getOrderAttributeByUuid(String uuid)
                                throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderAttributeByUuid(String)

getAllOrderAttributeTypes

List<OrderAttributeType> getAllOrderAttributeTypes()
                                            throws DAOException

Throws:

DAOException

See Also:

OrderService.getAllOrderAttributeTypes()

getOrderAttributeTypeById

OrderAttributeType getOrderAttributeTypeById(Integer orderAttributeTypeId)
                                      throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderAttributeTypeById(Integer)

getOrderAttributeTypeByUuid

OrderAttributeType getOrderAttributeTypeByUuid(String uuid)
                                        throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderAttributeTypeByUuid(String)

saveOrderAttributeType

OrderAttributeType saveOrderAttributeType(OrderAttributeType orderAttributeType)
                                   throws DAOException

Throws:

DAOException

See Also:

OrderService.saveOrderAttributeType(OrderAttributeType)

deleteOrderAttributeType

void deleteOrderAttributeType(OrderAttributeType orderAttributeType)
                       throws DAOException

Throws:

DAOException

See Also:

OrderService.purgeOrderAttributeType(OrderAttributeType)

getOrderAttributeTypeByName

OrderAttributeType getOrderAttributeTypeByName(String name)
                                        throws DAOException

Throws:

DAOException

See Also:

OrderService.getOrderAttributeTypeByName(String)

getActiveOrders

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

See Also:

org.openmrs.api.OrderService#getActiveOrders(org.openmrs.Patient, org.openmrs.Visit, java.util.List, org.openmrs.CareSetting, java.util.Date)

getOrders

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

See Also:

org.openmrs.api.OrderService#getOrders(org.openmrs.Patient, org.openmrs.Visit, org.openmrs.CareSetting, java.util.List, boolean, boolean)