org.openmrs.api.impl

Class OrderServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.OrderServiceImpl

All Implemented Interfaces:

GlobalPropertyListener, OpenmrsService, OrderNumberGenerator, OrderService

@Transactional
public class OrderServiceImpl
extends BaseOpenmrsService
implements OrderService, OrderNumberGenerator, GlobalPropertyListener

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

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

PARALLEL_ORDERS

Constructor Summary

Constructors

Constructor and Description
OrderServiceImpl()

Method Summary

Modifier and Type	Method and Description
Order	discontinueOrder(Order orderToDiscontinue, Concept reasonCoded, java.util.Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
Order	discontinueOrder(Order orderToDiscontinue, java.lang.String reasonNonCoded, java.util.Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
java.util.List<Order>	getActiveOrders(Patient patient, OrderType orderType, CareSetting careSetting, java.util.Date asOfDate) Gets all active orders for the specified patient matching the specified CareSetting, OrderType as of the specified date.
java.util.List<Order>	getAllOrdersByPatient(Patient patient) Gets all orders for the specified patient including discontinuation orders
CareSetting	getCareSetting(java.lang.Integer careSettingId) Retrieve care setting
CareSetting	getCareSettingByName(java.lang.String name) Gets the CareSetting with the specified name
CareSetting	getCareSettingByUuid(java.lang.String uuid) Gets the CareSetting with the specified uuid
java.util.List<CareSetting>	getCareSettings(boolean includeRetired) Gets all non retired CareSettings if includeRetired is set to true otherwise retired ones are included too
Order	getDiscontinuationOrder(Order order) Get discontinuation order for the given order, it is the un voided discontinuation order with a previousOrder that matches the specified order.
java.util.List<Concept>	getDrugDispensingUnits() Gets the possible units of dispensing, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DISPENSING_UNITS_CONCEPT_UUID
java.util.List<Concept>	getDrugDosingUnits() Gets the possible drug dosing units, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DOSING_UNITS_CONCEPT_UUID
java.util.List<Concept>	getDrugRoutes() Gets the possible drug routes, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_ROUTES_CONCEPT_UUID
java.util.List<Concept>	getDurationUnits() Gets the possible units of duration, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DURATION_UNITS_CONCEPT_UUID
java.lang.String	getNewOrderNumber(OrderContext orderContext) Generates a new order number.
java.lang.Long	getNextOrderNumberSeedSequenceValue() Gets the next available order number seed
Order	getOrder(java.lang.Integer orderId) Get order by internal primary key identifier
Order	getOrderByOrderNumber(java.lang.String orderNumber) Gets the order identified by a given order number
Order	getOrderByUuid(java.lang.String uuid) Get Order by its UUID
java.util.List<OrderFrequency>	getOrderFrequencies(boolean includeRetired) Gets all order frequencies
java.util.List<OrderFrequency>	getOrderFrequencies(java.lang.String searchPhrase, java.util.Locale locale, boolean exactLocale, boolean includeRetired) Gets all non retired order frequencies associated to concepts that match the specified search phrase
OrderFrequency	getOrderFrequency(java.lang.Integer orderFrequencyId) Gets OrderFrequency that matches the specified orderFrequencyId
OrderFrequency	getOrderFrequencyByConcept(Concept concept) Gets an OrderFrequency that matches the specified concept
OrderFrequency	getOrderFrequencyByUuid(java.lang.String uuid) Gets OrderFrequency that matches the specified uuid
java.util.List<Order>	getOrderHistoryByConcept(Patient patient, Concept concept) Gets all Order objects that use this Concept for a given patient.
java.util.List<Order>	getOrderHistoryByOrderNumber(java.lang.String orderNumber) Gets the order matching the specified order number and its previous orders in the ordering they occurred, i.e if this order has a previous order, fetch it and if it also has a previous order then fetch it until the original one with no previous order is reached
java.util.List<Order>	getOrders(Patient patient, CareSetting careSetting, OrderType orderType, boolean includeVoided) Gets all Orders that match the specified parameters excluding discontinuation orders
OrderType	getOrderType(java.lang.Integer orderTypeId) Get OrderType by orderTypeId
OrderType	getOrderTypeByConcept(Concept concept) Gets the order type mapped to a given concept
OrderType	getOrderTypeByConceptClass(ConceptClass conceptClass) Gets the order type mapped to a given concept class
OrderType	getOrderTypeByName(java.lang.String orderTypeName) Gets OrderType that matches the specified name
OrderType	getOrderTypeByUuid(java.lang.String uuid) Get OrderType by uuid
java.util.List<OrderType>	getOrderTypes(boolean includeRetired) Get all order types, if includeRetired is set to true then retired ones will be included otherwise not
Order	getRevisionOrder(Order order) Get revision order for the given order, it is the order with the changes that was created as a replacement for the specified order.
java.util.List<OrderType>	getSubtypes(OrderType orderType, boolean includeRetired) Returns all descendants of a given order type for example Given TEST will get back LAB TEST and RADIOLOGY TEST; and Given LAB TEST, will might get back SEROLOGY, MICROBIOLOGY, and CHEMISTRY
java.util.List<Concept>	getTestSpecimenSources() Gets the possible test specimen sources, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_TEST_SPECIMEN_SOURCES_CONCEPT_UUID
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(java.lang.String propertyName) Called after a global property is deleted
void	purgeOrder(Order order) Completely delete an order from the database.
void	purgeOrder(Order order, boolean cascade) Completely delete an order from the database.
void	purgeOrderFrequency(OrderFrequency orderFrequency) Completely removes an order frequency from the database
void	purgeOrderType(OrderType orderType) Completely removes an order type from the database
OrderFrequency	retireOrderFrequency(OrderFrequency orderFrequency, java.lang.String reason) Retires the given order frequency in the database
OrderType	retireOrderType(OrderType orderType, java.lang.String reason) Retires the given order type in the database
Order	saveOrder(Order order, OrderContext orderContext) Save or update the given order in the database.
OrderFrequency	saveOrderFrequency(OrderFrequency orderFrequency) Creates or updates the given order frequency in the database
OrderType	saveOrderType(OrderType orderType) Creates or updates the given order type in the database
void	setOrderDAO(OrderDAO dao) Setter for the Order data access object.
boolean	supportsPropertyName(java.lang.String propertyName) Asks this listener whether it wants to be notified about the given property name
OrderFrequency	unretireOrderFrequency(OrderFrequency orderFrequency) Restores an order frequency that was previously retired in the database
OrderType	unretireOrderType(OrderType orderType) Restores an order type that was previously retired in the database
Order	unvoidOrder(Order order) Unvoid order record.
Order	voidOrder(Order order, java.lang.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,
                       OrderContext orderContext)
                throws APIException

Description copied from interface: OrderService

Save or update the given order in the database. If the OrderType for the order is not specified, then it will be set to the one set on the OrderContext if any, if none exists on the orderContext, then it will be set to the one associated to the ConceptClass of the ordered concept otherwise the save fails. If the CareSetting field of the order is not specified then it will default to the one set on the passed in OrderContext if any otherwise the save fails.

Specified by:

saveOrder in interface OrderService

Parameters:

order - the Order to save

orderContext - the OrderContext object

Returns:

the Order that was saved

Throws:

APIException

See Also:

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

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

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) This method is different from purgeOrder(Order order) above: If param cascade is false will completely delete an order from the database period If param cascade is true will completely delete an order from the database and delete any Obs that references the Order.

Specified by:

purgeOrder in interface OrderService

Parameters:

order - The Order to remove from the system

Throws:

APIException

See Also:

OrderService.purgeOrder(Order)

voidOrder

public Order voidOrder(Order order,
                       java.lang.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)

getOrder

@Transactional(readOnly=true)
public Order getOrder(java.lang.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)

getOrders

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

Description copied from interface: OrderService

Gets all Orders that match the specified parameters excluding discontinuation orders

Specified by:

getOrders in interface OrderService

Parameters:

patient - the patient to match on

careSetting - the CareSetting to match on

orderType - The OrderType to match on

includeVoided - Specifies whether voided orders should be included or not

Returns:

list of Orders matching the parameters

See Also:

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

getAllOrdersByPatient

public java.util.List<Order> getAllOrdersByPatient(Patient patient)

Description copied from interface: OrderService

Gets all orders for the specified patient including discontinuation orders

Specified by:

getAllOrdersByPatient in interface OrderService

Parameters:

patient - the patient to match on

Returns:

list of matching Order

See Also:

OrderService.getAllOrdersByPatient(org.openmrs.Patient)

getOrderByUuid

@Transactional(readOnly=true)
public Order getOrderByUuid(java.lang.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)

getDiscontinuationOrder

@Transactional(readOnly=true)
public Order getDiscontinuationOrder(Order order)
                                                            throws APIException

Description copied from interface: OrderService

Get discontinuation order for the given order, it is the un voided discontinuation order with a previousOrder that matches the specified order.

Specified by:

getDiscontinuationOrder in interface OrderService

Returns:

the discontinuation order or null if none

Throws:

APIException

See Also:

OrderService.getDiscontinuationOrder(Order)

getRevisionOrder

public Order getRevisionOrder(Order order)
                       throws APIException

Description copied from interface: OrderService

Get revision order for the given order, it is the order with the changes that was created as a replacement for the specified order. In other words, it is the un voided revise order with a previousOrder that matches the specified order.

Specified by:

getRevisionOrder in interface OrderService

Returns:

the revision order or null if none

Throws:

APIException

See Also:

OrderService.getRevisionOrder(Order)

getNewOrderNumber

public java.lang.String getNewOrderNumber(OrderContext orderContext)
                                   throws APIException

Description copied from interface: OrderNumberGenerator

Generates a new order number. Note that this method is invoked in a non thread-safe way, therefore implementations need to be thread safe.

Specified by:

getNewOrderNumber in interface OrderNumberGenerator

Parameters:

orderContext -

Returns:

the new order number

Throws:

APIException

See Also:

OrderNumberGenerator.getNewOrderNumber(org.openmrs.api.OrderContext)

getOrderByOrderNumber

@Transactional(readOnly=true)
public Order getOrderByOrderNumber(java.lang.String orderNumber)

Description copied from interface: OrderService

Gets the order identified by a given order number

Specified by:

getOrderByOrderNumber in interface OrderService

Parameters:

orderNumber - the order number

Returns:

the order object

See Also:

OrderService.getOrderByOrderNumber(java.lang.String)

getOrderHistoryByConcept

@Transactional(readOnly=true)
public java.util.List<Order> getOrderHistoryByConcept(Patient patient,
                                                                                    Concept concept)

Description copied from interface: OrderService

Gets all Order objects that use this Concept for a given patient. Orders will be returned in the order in which they occurred, i.e. sorted by startDate starting with the latest

Specified by:

getOrderHistoryByConcept in interface OrderService

Parameters:

patient - the patient.

concept - the concept.

Returns:

the list of orders.

See Also:

OrderService.getOrderHistoryByConcept(org.openmrs.Patient, org.openmrs.Concept)

getNextOrderNumberSeedSequenceValue

@Transactional(propagation=REQUIRES_NEW)
public java.lang.Long getNextOrderNumberSeedSequenceValue()

Description copied from interface: OrderService

Gets the next available order number seed

Specified by:

getNextOrderNumberSeedSequenceValue in interface OrderService

Returns:

the order number seed

See Also:

OrderService.getNextOrderNumberSeedSequenceValue()

getOrderHistoryByOrderNumber

@Transactional(readOnly=true)
public java.util.List<Order> getOrderHistoryByOrderNumber(java.lang.String orderNumber)

Description copied from interface: OrderService

Gets the order matching the specified order number and its previous orders in the ordering they occurred, i.e if this order has a previous order, fetch it and if it also has a previous order then fetch it until the original one with no previous order is reached

Specified by:

getOrderHistoryByOrderNumber in interface OrderService

Parameters:

orderNumber - the order number whose history to get

Returns:

a list of orders for given order number

See Also:

OrderService.getOrderHistoryByOrderNumber(java.lang.String)

getActiveOrders

@Transactional(readOnly=true)
public java.util.List<Order> getActiveOrders(Patient patient,
                                                                           OrderType orderType,
                                                                           CareSetting careSetting,
                                                                           java.util.Date asOfDate)

Description copied from interface: OrderService

Gets all active orders for the specified patient matching the specified CareSetting, OrderType as of the specified date. Below is the criteria for determining an active order:

 

 - Not voided
 - Not a discontinuation Order i.e one where action != Action#DISCONTINUE
 - dateActivated is before or equal to asOfDate
 - dateStopped and autoExpireDate are both null OR if it has dateStopped, then it should be
 after asOfDate OR if it has autoExpireDate, then it should be after asOfDate. NOTE: If both
 dateStopped and autoExpireDate are set then dateStopped wins because an order can never
 expire and then stopped later i.e. you stop an order that hasn't yet expired
 

 

Specified by:

getActiveOrders in interface OrderService

Parameters:

patient - the patient

orderType - The OrderType to match

careSetting - the care setting, returns all ignoring care setting if value is null

asOfDate - defaults to current time

Returns:

all active orders for given patient parameters

See Also:

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

getCareSetting

public CareSetting getCareSetting(java.lang.Integer careSettingId)

Description copied from interface: OrderService

Retrieve care setting

Specified by:

getCareSetting in interface OrderService

Returns:

the care setting

See Also:

OrderService.getCareSetting(Integer)

getCareSettingByUuid

public CareSetting getCareSettingByUuid(java.lang.String uuid)

Description copied from interface: OrderService

Gets the CareSetting with the specified uuid

Specified by:

getCareSettingByUuid in interface OrderService

Parameters:

uuid - the uuid to match on

Returns:

CareSetting

See Also:

OrderService.getCareSettingByUuid(String)

getCareSettingByName

public CareSetting getCareSettingByName(java.lang.String name)

Description copied from interface: OrderService

Gets the CareSetting with the specified name

Specified by:

getCareSettingByName in interface OrderService

Parameters:

name - the name to match on

Returns:

CareSetting

See Also:

OrderService.getCareSettingByName(String)

getCareSettings

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

Description copied from interface: OrderService

Gets all non retired CareSettings if includeRetired is set to true otherwise retired ones are included too

Specified by:

getCareSettings in interface OrderService

Parameters:

includeRetired - specifies whether retired care settings should be returned or not

Returns:

A List of CareSettings

See Also:

OrderService.getCareSettings(boolean)

getOrderTypeByName

public OrderType getOrderTypeByName(java.lang.String orderTypeName)

Description copied from interface: OrderService

Gets OrderType that matches the specified name

Specified by:

getOrderTypeByName in interface OrderService

Parameters:

orderTypeName - the name to match against

Returns:

OrderType

See Also:

OrderService.getOrderTypeByName(String)

getOrderFrequency

public OrderFrequency getOrderFrequency(java.lang.Integer orderFrequencyId)

Description copied from interface: OrderService

Gets OrderFrequency that matches the specified orderFrequencyId

Specified by:

getOrderFrequency in interface OrderService

Parameters:

orderFrequencyId - the id to match against

Returns:

OrderFrequency

See Also:

OrderService.getOrderFrequency(Integer)

getOrderFrequencyByUuid

public OrderFrequency getOrderFrequencyByUuid(java.lang.String uuid)

Description copied from interface: OrderService

Gets OrderFrequency that matches the specified uuid

Specified by:

getOrderFrequencyByUuid in interface OrderService

Parameters:

uuid - the uuid to match against

Returns:

OrderFrequency

See Also:

OrderService.getOrderFrequencyByUuid(String)

getOrderFrequencies

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

Description copied from interface: OrderService

Gets all order frequencies

Specified by:

getOrderFrequencies in interface OrderService

Parameters:

includeRetired - specifies whether retired ones should be included or not

Returns:

List

See Also:

OrderService.getOrderFrequencies(boolean)

getOrderFrequencies

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

Description copied from interface: OrderService

Gets all non retired order frequencies associated to concepts that match the specified search phrase

Specified by:

getOrderFrequencies in interface OrderService

Parameters:

searchPhrase - The string to match on

locale - The locale to match on when searching in associated concept names

exactLocale - If false then order frequencies associated to concepts with names in a broader locale will be matched e.g in case en_GB is passed in then en will be matched

includeRetired - Specifies if retired order frequencies that match should be included or not

Returns:

List

See Also:

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

discontinueOrder

public Order discontinueOrder(Order orderToDiscontinue,
                              Concept reasonCoded,
                              java.util.Date discontinueDate,
                              Provider orderer,
                              Encounter encounter)
                       throws java.lang.Exception

Description copied from interface: OrderService

Discontinues an order. Creates a new order that discontinues the orderToDiscontinue

Specified by:

discontinueOrder in interface OrderService

Returns:

the new order that discontinued orderToDiscontinue

Throws:

APIException - if the action of orderToDiscontinue is Order.Action.DISCONTINUE

java.lang.Exception

See Also:

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

discontinueOrder

public Order discontinueOrder(Order orderToDiscontinue,
                              java.lang.String reasonNonCoded,
                              java.util.Date discontinueDate,
                              Provider orderer,
                              Encounter encounter)
                       throws java.lang.Exception

Description copied from interface: OrderService

Discontinues an order. Creates a new order that discontinues the orderToDiscontinue.

Specified by:

discontinueOrder in interface OrderService

Returns:

the new order that discontinued orderToDiscontinue

Throws:

APIException - if the action of orderToDiscontinue is Order.Action.DISCONTINUE

java.lang.Exception

See Also:

OrderService.discontinueOrder(org.openmrs.Order, String, java.util.Date, org.openmrs.Provider, org.openmrs.Encounter)

saveOrderFrequency

public OrderFrequency saveOrderFrequency(OrderFrequency orderFrequency)
                                  throws APIException

Description copied from interface: OrderService

Creates or updates the given order frequency in the database

Specified by:

saveOrderFrequency in interface OrderService

Parameters:

orderFrequency - the order frequency to save

Returns:

the order frequency created/saved

Throws:

APIException

See Also:

OrderService.saveOrderFrequency(org.openmrs.OrderFrequency)

retireOrderFrequency

public OrderFrequency retireOrderFrequency(OrderFrequency orderFrequency,
                                           java.lang.String reason)

Description copied from interface: OrderService

Retires the given order frequency in the database

Specified by:

retireOrderFrequency in interface OrderService

Parameters:

orderFrequency - the order frequency to retire

reason - the retire reason

Returns:

the retired order frequency

See Also:

OrderService.retireOrderFrequency(org.openmrs.OrderFrequency, java.lang.String)

unretireOrderFrequency

public OrderFrequency unretireOrderFrequency(OrderFrequency orderFrequency)

Description copied from interface: OrderService

Restores an order frequency that was previously retired in the database

Specified by:

unretireOrderFrequency in interface OrderService

Parameters:

orderFrequency - the order frequency to unretire

Returns:

the unretired order frequency

See Also:

OrderService.unretireOrderFrequency(org.openmrs.OrderFrequency)

purgeOrderFrequency

public void purgeOrderFrequency(OrderFrequency orderFrequency)

Description copied from interface: OrderService

Completely removes an order frequency from the database

Specified by:

purgeOrderFrequency in interface OrderService

Parameters:

orderFrequency - the order frequency to purge

See Also:

OrderService.purgeOrderFrequency(org.openmrs.OrderFrequency)

getOrderFrequencyByConcept

@Transactional(readOnly=true)
public OrderFrequency getOrderFrequencyByConcept(Concept concept)

Description copied from interface: OrderService

Gets an OrderFrequency that matches the specified concept

Specified by:

getOrderFrequencyByConcept in interface OrderService

Parameters:

concept - the concept to match against

Returns:

OrderFrequency

See Also:

OrderService.getOrderFrequencyByConcept(org.openmrs.Concept)

supportsPropertyName

public boolean supportsPropertyName(java.lang.String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name

See Also:

GlobalPropertyListener.supportsPropertyName(String)

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

See Also:

GlobalPropertyListener.globalPropertyChanged(org.openmrs.GlobalProperty)

globalPropertyDeleted

public void globalPropertyDeleted(java.lang.String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted

See Also:

GlobalPropertyListener.globalPropertyDeleted(String)

getOrderType

@Transactional(readOnly=true)
public OrderType getOrderType(java.lang.Integer orderTypeId)

Description copied from interface: OrderService

Get OrderType by orderTypeId

Specified by:

getOrderType in interface OrderService

Parameters:

orderTypeId - the orderTypeId to match on

Returns:

order type object associated with given id

See Also:

OrderService.getOrderType(Integer)

getOrderTypeByUuid

@Transactional(readOnly=true)
public OrderType getOrderTypeByUuid(java.lang.String uuid)

Description copied from interface: OrderService

Get OrderType by uuid

Specified by:

getOrderTypeByUuid in interface OrderService

Parameters:

uuid - the uuid to match on

Returns:

order type object associated with given uuid

See Also:

OrderService.getOrderTypeByUuid(String)

getOrderTypes

@Transactional(readOnly=true)
public java.util.List<OrderType> getOrderTypes(boolean includeRetired)

Description copied from interface: OrderService

Get all order types, if includeRetired is set to true then retired ones will be included otherwise not

Specified by:

getOrderTypes in interface OrderService

Parameters:

includeRetired - boolean flag which indicate search needs to look at retired order types or not

Returns:

list of order types

See Also:

OrderService.getOrderTypes(boolean)

saveOrderType

public OrderType saveOrderType(OrderType orderType)

Description copied from interface: OrderService

Creates or updates the given order type in the database

Specified by:

saveOrderType in interface OrderService

Parameters:

orderType - the order type to save

Returns:

the order type created/saved

See Also:

OrderService.saveOrderType(org.openmrs.OrderType)

purgeOrderType

public void purgeOrderType(OrderType orderType)

Description copied from interface: OrderService

Completely removes an order type from the database

Specified by:

purgeOrderType in interface OrderService

Parameters:

orderType - the order type to purge

See Also:

OrderService.purgeOrderType(org.openmrs.OrderType)

retireOrderType

public OrderType retireOrderType(OrderType orderType,
                                 java.lang.String reason)

Description copied from interface: OrderService

Retires the given order type in the database

Specified by:

retireOrderType in interface OrderService

Parameters:

orderType - the order type to retire

reason - the retire reason

Returns:

the retired order type

See Also:

OrderService.retireOrderType(org.openmrs.OrderType, String)

unretireOrderType

public OrderType unretireOrderType(OrderType orderType)

Description copied from interface: OrderService

Restores an order type that was previously retired in the database

Specified by:

unretireOrderType in interface OrderService

Parameters:

orderType - the order type to unretire

Returns:

the unretired order type

See Also:

OrderService.unretireOrderType(org.openmrs.OrderType)

getSubtypes

@Transactional(readOnly=true)
public java.util.List<OrderType> getSubtypes(OrderType orderType,
                                                                           boolean includeRetired)

Description copied from interface: OrderService

Returns all descendants of a given order type for example Given TEST will get back LAB TEST and RADIOLOGY TEST; and Given LAB TEST, will might get back SEROLOGY, MICROBIOLOGY, and CHEMISTRY

Specified by:

getSubtypes in interface OrderService

Parameters:

orderType - the order type which needs to search for its' dependencies

includeRetired - boolean flag for include retired order types or not

Returns:

list of order type which matches the given order type

See Also:

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

getOrderTypeByConceptClass

@Transactional(readOnly=true)
public OrderType getOrderTypeByConceptClass(ConceptClass conceptClass)

Description copied from interface: OrderService

Gets the order type mapped to a given concept class

Specified by:

getOrderTypeByConceptClass in interface OrderService

Parameters:

conceptClass - the concept class

Returns:

the matching order type

See Also:

OrderService.getOrderTypeByConceptClass(org.openmrs.ConceptClass)

getOrderTypeByConcept

@Transactional(readOnly=true)
public OrderType getOrderTypeByConcept(Concept concept)

Description copied from interface: OrderService

Gets the order type mapped to a given concept

Specified by:

getOrderTypeByConcept in interface OrderService

Parameters:

concept - the concept

Returns:

the matching order type

See Also:

OrderService.getOrderTypeByConcept(org.openmrs.Concept)

getDrugRoutes

@Transactional(readOnly=true)
public java.util.List<Concept> getDrugRoutes()

Description copied from interface: OrderService

Gets the possible drug routes, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_ROUTES_CONCEPT_UUID

Specified by:

getDrugRoutes in interface OrderService

Returns:

concept list of drug routes

See Also:

OrderService.getDrugRoutes()

getDrugDosingUnits

@Transactional(readOnly=true)
public java.util.List<Concept> getDrugDosingUnits()

Description copied from interface: OrderService

Gets the possible drug dosing units, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DOSING_UNITS_CONCEPT_UUID

Specified by:

getDrugDosingUnits in interface OrderService

Returns:

concept list of drug dosing units

getDrugDispensingUnits

@Transactional(readOnly=true)
public java.util.List<Concept> getDrugDispensingUnits()

Description copied from interface: OrderService

Gets the possible units of dispensing, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DRUG_DISPENSING_UNITS_CONCEPT_UUID

Specified by:

getDrugDispensingUnits in interface OrderService

Returns:

concept list of units of dispensing

getDurationUnits

@Transactional(readOnly=true)
public java.util.List<Concept> getDurationUnits()

Description copied from interface: OrderService

Gets the possible units of duration, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_DURATION_UNITS_CONCEPT_UUID

Specified by:

getDurationUnits in interface OrderService

Returns:

concept list of units of duration

getTestSpecimenSources

public java.util.List<Concept> getTestSpecimenSources()

Description copied from interface: OrderService

Gets the possible test specimen sources, i.e the set members for the concept that matches the uuid specified as the value for the global property OpenmrsConstants.GP_TEST_SPECIMEN_SOURCES_CONCEPT_UUID

Specified by:

getTestSpecimenSources in interface OrderService

Returns:

concept list of specimen sources

See Also:

OrderService.getTestSpecimenSources()