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

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, Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
Order	discontinueOrder(Order orderToDiscontinue, String reasonNonCoded, Date discontinueDate, Provider orderer, Encounter encounter) Discontinues an order.
List<Order>	getActiveOrders(Patient patient, OrderType orderType, CareSetting careSetting, Date asOfDate) Gets all active orders for the specified patient matching the specified CareSetting, OrderType as of the specified date.
List<Order>	getActiveOrders(Patient patient, Visit visit, OrderType orderType, CareSetting careSetting, Date asOfDate)
List<OrderAttributeType>	getAllOrderAttributeTypes() Returns all order attribute types
List<OrderGroupAttributeType>	getAllOrderGroupAttributeTypes() Returns all order group attribute types
List<Order>	getAllOrdersByPatient(Patient patient) Gets all orders for the specified patient including discontinuation orders
CareSetting	getCareSetting(Integer careSettingId) Retrieve care setting
CareSetting	getCareSettingByName(String name) Gets the CareSetting with the specified name
CareSetting	getCareSettingByUuid(String uuid) Gets the CareSetting with the specified uuid
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.
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
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
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
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
String	getNewOrderNumber(OrderContext orderContext) Generates a new order number.
Long	getNextOrderNumberSeedSequenceValue() Gets the next available order number seed
Concept	getNonCodedDrugConcept() Gets the non coded drug concept, i.e the concept that matches the uuid specified as the value for the global property {@link OpenmrsConstants#GP_DRUG_ORDER_DRUG_OTHER
Order	getOrder(Integer orderId) Get order by internal primary key identifier
OrderAttribute	getOrderAttributeByUuid(String uuid) Fetches a given order attribute using the provided uuid
OrderAttributeType	getOrderAttributeTypeById(Integer id) Fetches order attribute type using provided Id
OrderAttributeType	getOrderAttributeTypeByName(String orderAttributeTypeName) Retrieves an order attribute type object based on the name provided
OrderAttributeType	getOrderAttributeTypeByUuid(String uuid) Fetches order attribute type using provided uuid
Order	getOrderByOrderNumber(String orderNumber) Gets the order identified by a given order number
Order	getOrderByUuid(String uuid) Get Order by its UUID
List<OrderFrequency>	getOrderFrequencies(boolean includeRetired) Gets all order frequencies
List<OrderFrequency>	getOrderFrequencies(String searchPhrase, Locale locale, boolean exactLocale, boolean includeRetired) Gets all non retired order frequencies associated to concepts that match the specified search phrase
OrderFrequency	getOrderFrequency(Integer orderFrequencyId) Gets OrderFrequency that matches the specified orderFrequencyId
OrderFrequency	getOrderFrequencyByConcept(Concept concept) Gets an OrderFrequency that matches the specified concept
OrderFrequency	getOrderFrequencyByUuid(String uuid) Gets OrderFrequency that matches the specified uuid
OrderGroup	getOrderGroup(Integer orderGroupId) Fetches the OrderGroup by Id.
OrderGroupAttribute	getOrderGroupAttributeByUuid(String uuid) Fetches a given order group attribute using the provided uuid
OrderGroupAttributeType	getOrderGroupAttributeType(Integer id) Fetches order group attribute type using provided Id
OrderGroupAttributeType	getOrderGroupAttributeTypeByName(String orderGroupAttributeTypeName) Retrieves an order group attribute type object based on the name provided
OrderGroupAttributeType	getOrderGroupAttributeTypeByUuid(String uuid) Fetches order group attribute type using provided uuid
OrderGroup	getOrderGroupByUuid(String uuid) Fetches the OrderGroup By Uuid.
List<OrderGroup>	getOrderGroupsByEncounter(Encounter encounter) Fetches all order groups for the specified encounter
List<OrderGroup>	getOrderGroupsByPatient(Patient patient) Fetches all order groups for the specified patient
List<Order>	getOrderHistoryByConcept(Patient patient, Concept concept) Gets all Order objects that use this Concept for a given patient.
List<Order>	getOrderHistoryByOrderNumber(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
List<Order>	getOrders(OrderSearchCriteria orderSearchCriteria) Get all orders that match a variety of (nullable) criteria contained in the parameter object.
List<Order>	getOrders(Patient patient, CareSetting careSetting, OrderType orderType, boolean includeVoided) Gets all Orders that match the specified parameters excluding discontinuation orders
List<Order>	getOrders(Patient patient, Visit visit, CareSetting careSetting, OrderType orderType, boolean includeVoided)
OrderType	getOrderType(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(String orderTypeName) Gets OrderType that matches the specified name
OrderType	getOrderTypeByUuid(String uuid) Get OrderType by uuid
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.
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
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(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	purgeOrderAttributeType(OrderAttributeType orderAttributeType) Completely removes an order attribute type from the database
void	purgeOrderFrequency(OrderFrequency orderFrequency) Completely removes an order frequency from the database
void	purgeOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Completely removes an order group attribute type from the database
void	purgeOrderType(OrderType orderType) Completely removes an order type from the database
OrderAttributeType	retireOrderAttributeType(OrderAttributeType orderAttributeType, String reason) Retires the given order attribute type in the database
OrderFrequency	retireOrderFrequency(OrderFrequency orderFrequency, String reason) Retires the given order frequency in the database
OrderGroupAttributeType	retireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType, String reason) Retires the given order group attribute type in the database
OrderType	retireOrderType(OrderType orderType, 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.
OrderAttributeType	saveOrderAttributeType(OrderAttributeType orderAttributeType) Creates or updates the given order attribute type in the database
OrderFrequency	saveOrderFrequency(OrderFrequency orderFrequency) Creates or updates the given order frequency in the database
OrderGroup	saveOrderGroup(OrderGroup orderGroup) Saves the orderGroup.
OrderGroup	saveOrderGroup(OrderGroup orderGroup, OrderContext orderContext) Saves an order group with a specific order context
OrderGroupAttributeType	saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Creates or updates the given order group attribute type in the database
OrderType	saveOrderType(OrderType orderType) Creates or updates the given order type in the database
Order	saveRetrospectiveOrder(Order order, OrderContext orderContext) Save or update the given retrospective order in the database.
void	setOrderDAO(OrderDAO dao) Setter for the Order data access object.
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name
OrderAttributeType	unretireOrderAttributeType(OrderAttributeType orderAttributeType) Restores an order attribute type that was previously retired in the database
OrderFrequency	unretireOrderFrequency(OrderFrequency orderFrequency) Restores an order frequency that was previously retired in the database
OrderGroupAttributeType	unretireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType) Restores an order group attribute type 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	updateOrderFulfillerStatus(Order order, Order.FulfillerStatus orderFulfillerStatus, String fullFillerComment) Updates the fulfillerStatus of an order and the related comment and finally persists it
Order	updateOrderFulfillerStatus(Order order, Order.FulfillerStatus orderFulfillerStatus, String fullFillerComment, String accessionNumber) Updates the fulfillerStatus of an order and the related comment and finally persists it
Order	voidOrder(Order order, 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

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 - Should not save order if order doesnt validate Should discontinue existing active order if new order being saved with action to discontinue Should pass if the existing drug order matches the concept and drug of the DC order Should fail if the existing drug order matches the concept and not drug of the DC order Should discontinue previousOrder if it is not already discontinued Should fail if concept in previous order does not match this concept Should not allow editing an existing order Should not allow revising a voided order Should not allow revising a stopped order Should not allow revising an expired order Should not allow revising an order with no previous order Should save a revised order Should save a revised order for a scheduled order which is not started Should set order number specified in the context if specified Should set the order number returned by the configured generator Should set order type if null but mapped to the concept class Should fail if order type is null and not mapped to the concept class Should default to care setting and order type defined in the order context if null Should not allow changing the patient of the previous order when revising an order Should not allow changing the careSetting of the previous order when revising an order Should not allow changing the concept of the previous order when revising an order Should not allow changing the drug of the previous drug order when revising an order Should fail if concept in previous order does not match that of the revised order Should fail if the existing drug order matches the concept and not drug of the revised order Should fail if the order type of the previous order does not match Should fail if the java type of the previous order does not match Should fail if the careSetting of the previous order does not match Should set concept for drug orders if null Should pass for a discontinuation order with no previous order Should fail if an active drug order for the same concept and care setting exists Should pass if an active test order for the same concept and care setting exists Should pass if an active order for the same concept exists in a different care setting Should set Order type of Drug Order to drug order if not set and concept not mapped Should set Order type of Test Order to test order if not set and concept not mapped Should throw AmbiguousOrderException if an active drug order for the same drug formulation exists Should pass if an active order for the same concept exists in a different care setting Should fail for revision order if an active drug order for the same concept and care settings exists Should pass for revision order if an active test order for the same concept and care settings exists Should roll the autoExpireDate to the end of the day if it has no time component Should not change the autoExpireDate if it has a time component Should throw AmbiguousOrderException if disconnecting multiple active orders for the given concept Should throw AmbiguousOrderException if disconnecting multiple active drug orders with the same drug

See Also:

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

saveOrderGroup

public OrderGroup saveOrderGroup(OrderGroup orderGroup)
                          throws APIException

Description copied from interface: OrderService

Saves the orderGroup. It also saves the list of orders that are present within the orderGroup.

Specified by:

saveOrderGroup in interface OrderService

Parameters:

orderGroup - the orderGroup to be saved

Throws:

APIException

See Also:

OrderService.saveOrderGroup(org.openmrs.OrderGroup)

saveOrderGroup

public OrderGroup saveOrderGroup(OrderGroup orderGroup,
                                 OrderContext orderContext)
                          throws APIException

Description copied from interface: OrderService

Saves an order group with a specific order context

Specified by:

saveOrderGroup in interface OrderService

Parameters:

orderGroup - the order group to be saved

orderContext - the order context data transfer object containing care setting and the order type to save with the order group

Returns:

the order group that was saved with the specified order context data

Throws:

APIException

See Also:

OrderService.saveOrderGroup(org.openmrs.OrderGroup, org.openmrs.api.OrderContext)

saveRetrospectiveOrder

public Order saveRetrospectiveOrder(Order order,
                                    OrderContext orderContext)

Description copied from interface: OrderService

Save or update the given retrospective 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. Retrospective entry of orders can affect downstream systems that acts on orders created. Orders cannot be stopped if they are already stopped in retrospective entry.

Specified by:

saveRetrospectiveOrder in interface OrderService

Parameters:

order - the Order to save

orderContext - the OrderContext object

Returns:

the Order that was saved

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 - Should delete order from the database

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,
                       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 - Should void an order Should unset dateStopped of the previous order if the specified order is a discontinuation Should unset dateStopped of the previous order if the specified order is a revision

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 Should unvoid an order Should stop the previous order if the specified order is a discontinuation Should stop the previous order if the specified order is a revision Should fail for a discontinuation order if the previousOrder is inactive Should fail for a revise order if the previousOrder is inactive

Throws:

APIException

See Also:

OrderService.unvoidOrder(org.openmrs.Order)

updateOrderFulfillerStatus

public Order updateOrderFulfillerStatus(Order order,
                                        Order.FulfillerStatus orderFulfillerStatus,
                                        String fullFillerComment)

Description copied from interface: OrderService

Updates the fulfillerStatus of an order and the related comment and finally persists it

Specified by:

updateOrderFulfillerStatus in interface OrderService

Parameters:

order - order whose fulfillerStatus should be changed

orderFulfillerStatus - describes the new Order.FulfillerStatus the order should be set to

fullFillerComment - is a string which describes a comment that is set while changing the FulfillerStatus

Returns:

the Order that is updated with an according fulfillerStatus and fulFillerComment Should set the new fulfillerStatus Should set the new fulFillerComment Should not update fulfillerStatus or fulFillerComment if null passed in to that field Should save the changed order

updateOrderFulfillerStatus

public Order updateOrderFulfillerStatus(Order order,
                                        Order.FulfillerStatus orderFulfillerStatus,
                                        String fullFillerComment,
                                        String accessionNumber)

Description copied from interface: OrderService

Updates the fulfillerStatus of an order and the related comment and finally persists it

Specified by:

updateOrderFulfillerStatus in interface OrderService

Parameters:

order - order whose fulfillerStatus should be changed

orderFulfillerStatus - describes the new Order.FulfillerStatus the order should be set to

fullFillerComment - is a string which describes a comment that is set while changing the FulfillerStatus

accessionNumber - is the accession number to set

Returns:

the Order that is updated with an according fulfillerStatus and fulFillerComment and accession number Should set the new fulfillerStatus Should set the new fulFillerComment Should set the new accessionNumber Should not update fulfillerStatus or fulFillerComment or accessionNumber if null passed in to that field Should save the changed order

getOrder

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

getOrders

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

Specified by:

getOrders in interface OrderService

visit - the Visit to restrict orders (optional)

See Also:

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

getAllOrdersByPatient

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

getOrders

public List<Order> getOrders(OrderSearchCriteria orderSearchCriteria)

Description copied from interface: OrderService

Get all orders that match a variety of (nullable) criteria contained in the parameter object. Each extra value for a parameter that is provided acts as an "and" and will reduce the number of results returned

Specified by:

getOrders in interface OrderService

Parameters:

orderSearchCriteria - the object containing search parameters

Returns:

a list of orders matching the search criteria

getOrderByUuid

@Transactional(readOnly=true)
public Order getOrderByUuid(String uuid)
                                                   throws APIException

Description copied from interface: OrderService

Get Order by its UUID

Specified by:

getOrderByUuid in interface OrderService

Returns:

order or null Should find object given valid uuid Should return null if no object found with given uuid

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 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 Should always return unique orderNumbers when called multiple times without saving orders

Throws:

APIException

See Also:

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

getOrderByOrderNumber

@Transactional(readOnly=true)
public Order getOrderByOrderNumber(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 Should find object given valid order number Should return null if no object found with given order number

See Also:

OrderService.getOrderByOrderNumber(java.lang.String)

getOrderHistoryByConcept

@Transactional(readOnly=true)
public 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. Should return orders with the given concept Should return empty list for concept without orders Should reject a null patient Should reject a null concept

See Also:

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

getNextOrderNumberSeedSequenceValue

@Transactional(propagation=REQUIRES_NEW)
public 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 List<Order> getOrderHistoryByOrderNumber(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 Should return all order history for given order number

See Also:

OrderService.getOrderHistoryByOrderNumber(java.lang.String)

getActiveOrders

@Transactional(readOnly=true)
public List<Order> getActiveOrders(Patient patient,
                                                                 OrderType orderType,
                                                                 CareSetting careSetting,
                                                                 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)

getActiveOrders

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

Specified by:

getActiveOrders in interface OrderService

visit - the Visit to restrict active orders (optional)

See Also:

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

getCareSetting

public CareSetting getCareSetting(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(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 Should return the care setting with the specified uuid

See Also:

OrderService.getCareSettingByUuid(String)

getCareSettingByName

public CareSetting getCareSettingByName(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 Should return the care setting with the specified name

See Also:

OrderService.getCareSettingByName(String)

getCareSettings

public 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 Should return only un retired care settings if includeRetired is set to false Should return retired care settings if includeRetired is set to true

See Also:

OrderService.getCareSettings(boolean)

getOrderTypeByName

public OrderType getOrderTypeByName(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(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(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 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 Should return only non retired order frequencies if includeRetired is set to false Should return all the order frequencies if includeRetired is set to true

Returns:

List<OrderFrequency>

See Also:

OrderService.getOrderFrequencies(boolean)

getOrderFrequencies

public List<OrderFrequency> getOrderFrequencies(String searchPhrase,
                                                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<OrderFrequency>

See Also:

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

discontinueOrder

public Order discontinueOrder(Order orderToDiscontinue,
                              Concept reasonCoded,
                              Date discontinueDate,
                              Provider orderer,
                              Encounter encounter)

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

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,
                              String reasonNonCoded,
                              Date discontinueDate,
                              Provider orderer,
                              Encounter encounter)

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

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,
                                           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(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(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(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 Should find order type object given valid id Should return null if no order type object found with given id

See Also:

OrderService.getOrderType(Integer)

getOrderTypeByUuid

@Transactional(readOnly=true)
public OrderType getOrderTypeByUuid(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 Should find order type object given valid uuid Should return null if no order type object found with given uuid

See Also:

OrderService.getOrderTypeByUuid(String)

getOrderTypes

@Transactional(readOnly=true)
public 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 Should get all order types if includeRetired is set to true Should get all non retired order types if includeRetired is set to false

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

getNonCodedDrugConcept

public Concept getNonCodedDrugConcept()

Description copied from interface: OrderService

Gets the non coded drug concept, i.e the concept that matches the uuid specified as the value for the global property {@link OpenmrsConstants#GP_DRUG_ORDER_DRUG_OTHER

Specified by:

getNonCodedDrugConcept in interface OrderService

Returns:

concept of non coded drug

getOrderGroupByUuid

@Transactional(readOnly=true)
public OrderGroup getOrderGroupByUuid(String uuid)
                                                             throws APIException

Description copied from interface: OrderService

Fetches the OrderGroup By Uuid.

Specified by:

getOrderGroupByUuid in interface OrderService

Parameters:

uuid - Uuid Of the OrderGroup

Returns:

saved OrderGroup

Throws:

APIException

getOrderGroup

@Transactional(readOnly=true)
public OrderGroup getOrderGroup(Integer orderGroupId)
                                                       throws APIException

Description copied from interface: OrderService

Fetches the OrderGroup by Id.

Specified by:

getOrderGroup in interface OrderService

Parameters:

orderGroupId - Id of the OrderGroup

Returns:

saved OrderGroup

Throws:

APIException

getOrderGroupsByPatient

public List<OrderGroup> getOrderGroupsByPatient(Patient patient)
                                         throws APIException

Description copied from interface: OrderService

Fetches all order groups for the specified patient

Specified by:

getOrderGroupsByPatient in interface OrderService

Parameters:

patient - the patient to match on

Returns:

list of matching OrderGroups

Throws:

APIException

getOrderGroupsByEncounter

public List<OrderGroup> getOrderGroupsByEncounter(Encounter encounter)
                                           throws APIException

Description copied from interface: OrderService

Fetches all order groups for the specified encounter

Specified by:

getOrderGroupsByEncounter in interface OrderService

Parameters:

encounter - the encounter to match on

Returns:

list of matching OrderGroups

Throws:

APIException

getAllOrderGroupAttributeTypes

@Transactional(readOnly=true)
public List<OrderGroupAttributeType> getAllOrderGroupAttributeTypes()
                                                                                           throws APIException

Description copied from interface: OrderService

Returns all order group attribute types

Specified by:

getAllOrderGroupAttributeTypes in interface OrderService

Returns:

all OrderGroupAttributeTypes

Throws:

APIException

See Also:

org.openmrs.api.OrderService#getOrderGroupAttributeTypes()

getOrderGroupAttributeType

@Transactional(readOnly=true)
public OrderGroupAttributeType getOrderGroupAttributeType(Integer id)
                                                                                 throws APIException

Description copied from interface: OrderService

Fetches order group attribute type using provided Id

Specified by:

getOrderGroupAttributeType in interface OrderService

Returns:

the OrderGroupAttributeType with the given internal id

Throws:

APIException

See Also:

org.openmrs.api.OrderService#getOrderGroupAttributeTypeById()

getOrderGroupAttributeTypeByUuid

@Transactional(readOnly=true)
public OrderGroupAttributeType getOrderGroupAttributeTypeByUuid(String uuid)
                                                                                       throws APIException

Description copied from interface: OrderService

Fetches order group attribute type using provided uuid

Specified by:

getOrderGroupAttributeTypeByUuid in interface OrderService

Parameters:

uuid - The uuid of the order group attribute type to fetch from the database

Returns:

the OrderGroupAttributeType with the given uuid

Throws:

APIException

See Also:

org.openmrs.api.OrderService#getOrderGroupAttributeTypeByUuid()

saveOrderGroupAttributeType

public OrderGroupAttributeType saveOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                    throws APIException

Description copied from interface: OrderService

Creates or updates the given order group attribute type in the database

Specified by:

saveOrderGroupAttributeType in interface OrderService

Parameters:

orderGroupAttributeType - The order group attribute type to save in the database

Returns:

the order group attribute type created or saved

Throws:

APIException

See Also:

org.openmrs.api.OrderService#saveOrderGroupAttributeType()

retireOrderGroupAttributeType

public OrderGroupAttributeType retireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType,
                                                             String reason)
                                                      throws APIException

Description copied from interface: OrderService

Retires the given order group attribute type in the database

Specified by:

retireOrderGroupAttributeType in interface OrderService

Parameters:

orderGroupAttributeType - The order group attribute type to retire

reason - The reason why the order group attribute type is being retired

Returns:

the order group attribute type retired

Throws:

APIException

See Also:

org.openmrs.api.OrderService#retireOrderGroupAttributeType()

unretireOrderGroupAttributeType

public OrderGroupAttributeType unretireOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                                        throws APIException

Description copied from interface: OrderService

Restores an order group attribute type that was previously retired in the database

Specified by:

unretireOrderGroupAttributeType in interface OrderService

Parameters:

orderGroupAttributeType - The order group attribute type to unretire

Returns:

the order group attribute type unretired

Throws:

APIException

See Also:

org.openmrs.api.OrderService#unretireOrderGroupAttributeType()

purgeOrderGroupAttributeType

public void purgeOrderGroupAttributeType(OrderGroupAttributeType orderGroupAttributeType)
                                  throws APIException

Description copied from interface: OrderService

Completely removes an order group attribute type from the database

Specified by:

purgeOrderGroupAttributeType in interface OrderService

Parameters:

orderGroupAttributeType - The order group attribute type to purge

Throws:

APIException

See Also:

org.openmrs.api.OrderService#purgeOrderGroupAttributeType()

getOrderGroupAttributeTypeByName

@Transactional(readOnly=true)
public OrderGroupAttributeType getOrderGroupAttributeTypeByName(String orderGroupAttributeTypeName)
                                                                                       throws APIException

Description copied from interface: OrderService

Retrieves an order group attribute type object based on the name provided

Specified by:

getOrderGroupAttributeTypeByName in interface OrderService

Parameters:

orderGroupAttributeTypeName - The name of the order group attribute type to fetch

Returns:

the OrderGroupAttributeType with the specified name

Throws:

APIException

See Also:

org.openmrs.api.OrderService#getOrderGroupAttributeTypeByName()

getOrderGroupAttributeByUuid

@Transactional(readOnly=true)
public OrderGroupAttribute getOrderGroupAttributeByUuid(String uuid)
                                                                               throws APIException

Description copied from interface: OrderService

Fetches a given order group attribute using the provided uuid

Specified by:

getOrderGroupAttributeByUuid in interface OrderService

Parameters:

uuid - The uuid of the order group attribute to fetch

Returns:

the OrderGroupAttribute with the given uuid

Throws:

APIException

See Also:

org.openmrs.api.OrderService#getOrderGroupAttributeByUuid()

getAllOrderAttributeTypes

@Transactional(readOnly=true)
public List<OrderAttributeType> getAllOrderAttributeTypes()
                                                                                 throws APIException

Description copied from interface: OrderService

Returns all order attribute types

Specified by:

getAllOrderAttributeTypes in interface OrderService

Returns:

all OrderAttributeTypes

Throws:

APIException

See Also:

OrderService.getAllOrderAttributeTypes()

getOrderAttributeTypeById

@Transactional(readOnly=true)
public OrderAttributeType getOrderAttributeTypeById(Integer id)
                                                                           throws APIException

Description copied from interface: OrderService

Fetches order attribute type using provided Id

Specified by:

getOrderAttributeTypeById in interface OrderService

Returns:

the OrderAttributeType with the given internal id

Throws:

APIException

See Also:

OrderService.getOrderAttributeTypeById(Integer)

getOrderAttributeTypeByUuid

@Transactional(readOnly=true)
public OrderAttributeType getOrderAttributeTypeByUuid(String uuid)
                                                                             throws APIException

Description copied from interface: OrderService

Fetches order attribute type using provided uuid

Specified by:

getOrderAttributeTypeByUuid in interface OrderService

Parameters:

uuid - The uuid of the order attribute type to fetch from the database

Returns:

the OrderAttributeType with the given uuid

Throws:

APIException

See Also:

OrderService.getOrderAttributeTypeByUuid(String)

saveOrderAttributeType

public OrderAttributeType saveOrderAttributeType(OrderAttributeType orderAttributeType)
                                          throws APIException

Description copied from interface: OrderService

Creates or updates the given order attribute type in the database

Specified by:

saveOrderAttributeType in interface OrderService

Parameters:

orderAttributeType - The order attribute type to save in the database

Returns:

the order attribute type created or saved

Throws:

APIException

See Also:

OrderService.saveOrderAttributeType(OrderAttributeType)

retireOrderAttributeType

public OrderAttributeType retireOrderAttributeType(OrderAttributeType orderAttributeType,
                                                   String reason)
                                            throws APIException

Description copied from interface: OrderService

Retires the given order attribute type in the database

Specified by:

retireOrderAttributeType in interface OrderService

Parameters:

orderAttributeType - The order attribute type to retire

reason - The reason why the order attribute type is being retired

Returns:

the order attribute type retired

Throws:

APIException

See Also:

org.openmrs.api.OrderService#retireOrderAttributeType(OrderAttributeType)

unretireOrderAttributeType

public OrderAttributeType unretireOrderAttributeType(OrderAttributeType orderAttributeType)
                                              throws APIException

Description copied from interface: OrderService

Restores an order attribute type that was previously retired in the database

Specified by:

unretireOrderAttributeType in interface OrderService

Parameters:

orderAttributeType - The order attribute type to unretire

Returns:

the order attribute type unretired

Throws:

APIException

See Also:

OrderService.unretireOrderAttributeType(OrderAttributeType)

purgeOrderAttributeType

public void purgeOrderAttributeType(OrderAttributeType orderAttributeType)
                             throws APIException

Description copied from interface: OrderService

Completely removes an order attribute type from the database

Specified by:

purgeOrderAttributeType in interface OrderService

Parameters:

orderAttributeType - The order attribute type to purge

Throws:

APIException

See Also:

OrderService.purgeOrderAttributeType(OrderAttributeType)

getOrderAttributeTypeByName

@Transactional(readOnly=true)
public OrderAttributeType getOrderAttributeTypeByName(String orderAttributeTypeName)
                                                                             throws APIException

Description copied from interface: OrderService

Retrieves an order attribute type object based on the name provided

Specified by:

getOrderAttributeTypeByName in interface OrderService

Parameters:

orderAttributeTypeName - The name of the order attribute type to fetch

Returns:

the OrderAttributeType with the specified name

Throws:

APIException

See Also:

OrderService.getOrderAttributeTypeByName(String)

getOrderAttributeByUuid

@Transactional(readOnly=true)
public OrderAttribute getOrderAttributeByUuid(String uuid)
                                                                     throws APIException

Description copied from interface: OrderService

Fetches a given order attribute using the provided uuid

Specified by:

getOrderAttributeByUuid in interface OrderService

Parameters:

uuid - The uuid of the order attribute to fetch

Returns:

the OrderAttribute with the given uuid

Throws:

APIException

See Also:

OrderService.getOrderAttributeByUuid(String)