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

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

Throws:

DAOException

See Also:

OrderService.getOrder(Integer)

getOrders

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

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

See Also:

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

getOrderByUuid

Order getOrderByUuid(java.lang.String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

deleteObsThatReference

void deleteObsThatReference(Order order)

Delete Obs that references an order

getOrderByOrderNumber

Order getOrderByOrderNumber(java.lang.String orderNumber)

See Also:

OrderService.getOrderByOrderNumber(java.lang.String)

getNextOrderNumberSeedSequenceValue

java.lang.Long getNextOrderNumberSeedSequenceValue()

Gets the next available order number seed

Returns:

the order number seed

getActiveOrders

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

See Also:

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

getCareSetting

CareSetting getCareSetting(java.lang.Integer careSettingId)

Get care setting by type

Parameters:

careSettingId -

Returns:

the care setting type

getCareSettingByUuid

CareSetting getCareSettingByUuid(java.lang.String uuid)

See Also:

OrderService.getCareSettingByUuid(String)

getCareSettingByName

CareSetting getCareSettingByName(java.lang.String name)

See Also:

OrderService.getCareSettingByName(String)

getCareSettings

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

See Also:

OrderService.getCareSettings(boolean)

getOrderTypeByName

OrderType getOrderTypeByName(java.lang.String orderTypeName)

getOrderFrequency

OrderFrequency getOrderFrequency(java.lang.Integer orderFrequencyId)

getOrderFrequencyByUuid

OrderFrequency getOrderFrequencyByUuid(java.lang.String uuid)

getOrderFrequencies

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

getOrderFrequencies

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

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)

getOrderType

OrderType getOrderType(java.lang.Integer orderTypeId)

getOrderTypeByUuid

OrderType getOrderTypeByUuid(java.lang.String uuid)

getOrderTypes

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

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

java.util.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

java.util.List<java.util.List<java.lang.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