org.openmrs.api.impl

Class OrderSetServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.OrderSetServiceImpl

All Implemented Interfaces:

OpenmrsService, OrderSetService

public class OrderSetServiceImpl
extends BaseOpenmrsService
implements OrderSetService

Field Summary

Fields

Modifier and Type	Field and Description
protected OrderSetDAO	dao

Constructor Summary

Constructors

Constructor and Description
OrderSetServiceImpl()

Method Summary

Modifier and Type	Method and Description
List<OrderSetAttributeType>	getAllOrderSetAttributeTypes() Get all order set attribute types
OrderSet	getOrderSet(Integer orderSetId) Gets a specific OrderSet with the matched orderSet Id.
OrderSetAttribute	getOrderSetAttributeByUuid(String uuid) Get order set attribute by uuid
OrderSetAttributeType	getOrderSetAttributeType(Integer id) Get order set attribute type from the database by a given internal id
OrderSetAttributeType	getOrderSetAttributeTypeByName(String name) Retrieves an order set attribute type object based on the name provided
OrderSetAttributeType	getOrderSetAttributeTypeByUuid(String uuid) Get order set attribute type by uuid
OrderSet	getOrderSetByUuid(String orderSetUuid) Gets a specific OrderSet with the matched orderSet uuid.
OrderSetMember	getOrderSetMemberByUuid(String uuid) Get OrderSetMember by uuid
List<OrderSet>	getOrderSets(boolean includeRetired) Gets all OrderSets that match the specified parameters excluding discontinuation orderSets.
void	purgeOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType) Completely removes an order set attribute type
OrderSet	retireOrderSet(OrderSet orderSet, String retireReason) Retires and OrderSet, with matched OrderSet
OrderSetAttributeType	retireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType, String reason) Retires the given order set attribute type
OrderSet	saveOrderSet(OrderSet orderSet) Save or update the given orderSet in the database.
OrderSetAttributeType	saveOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType) Creates or updates the given order set attribute type
void	setOrderSetDAO(OrderSetDAO dao) Setter for the OrderSet data access object.
OrderSet	unretireOrderSet(OrderSet orderSet) UnRetires and OrderSet, with matched OrderSet
OrderSetAttributeType	unretireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType) Restores an order set attribute type that was previous retired

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

Constructor Detail

OrderSetServiceImpl

public OrderSetServiceImpl()

Method Detail

setOrderSetDAO

public void setOrderSetDAO(OrderSetDAO dao)

Description copied from interface: OrderSetService

Setter for the OrderSet data access object. The dao is used for saving and getting orders to/from the database

Specified by:

setOrderSetDAO in interface OrderSetService

Parameters:

dao - The data access object to use

See Also:

OrderSetService.setOrderSetDAO(org.openmrs.api.db.OrderSetDAO)

saveOrderSet

@Transactional(readOnly=false)
public OrderSet saveOrderSet(OrderSet orderSet)
                                                     throws APIException

Description copied from interface: OrderSetService

Save or update the given orderSet in the database. If the OrderSet is retired it will set retired by and retired date. If OrderSetMembers are retired, it will set retired by and retired date.

Specified by:

saveOrderSet in interface OrderSetService

Parameters:

orderSet - the OrderSet to save

Returns:

the OrderSet that was saved

Throws:

APIException

retireOrderSet

@Transactional(readOnly=false)
public OrderSet retireOrderSet(OrderSet orderSet,
                                                              String retireReason)
                                                       throws APIException

Description copied from interface: OrderSetService

Retires and OrderSet, with matched OrderSet

Specified by:

retireOrderSet in interface OrderSetService

Parameters:

orderSet - Specifies the OrderSet to be retired

retireReason - Specifies the reason why the OrderSet has to be retired

Returns:

an orderSet

Throws:

APIException

See Also:

OrderSetService.retireOrderSet(OrderSet, String)

unretireOrderSet

@Transactional(readOnly=false)
public OrderSet unretireOrderSet(OrderSet orderSet)
                                                         throws APIException

Description copied from interface: OrderSetService

UnRetires and OrderSet, with matched OrderSet

Specified by:

unretireOrderSet in interface OrderSetService

Parameters:

orderSet - Specifies the OrderSet to be retired

Returns:

an orderSet

Throws:

APIException

See Also:

OrderSetService.unretireOrderSet(OrderSet)

getOrderSets

@Transactional(readOnly=true)
public List<OrderSet> getOrderSets(boolean includeRetired)
                                                          throws APIException

Description copied from interface: OrderSetService

Gets all OrderSets that match the specified parameters excluding discontinuation orderSets.

Specified by:

getOrderSets in interface OrderSetService

Parameters:

includeRetired - Specifies whether retired orders should be included or not

Returns:

list of OrderSets matching the parameters

Throws:

APIException

See Also:

OrderSetService.getOrderSets(boolean)

getOrderSet

@Transactional(readOnly=true)
public OrderSet getOrderSet(Integer orderSetId)
                                                   throws APIException

Description copied from interface: OrderSetService

Gets a specific OrderSet with the matched orderSet Id.

Specified by:

getOrderSet in interface OrderSetService

Parameters:

orderSetId - Specifies a saved orderSet id.

Returns:

OrderSet

Throws:

APIException

See Also:

OrderSetService.getOrderSet(Integer)

getOrderSetByUuid

@Transactional(readOnly=true)
public OrderSet getOrderSetByUuid(String orderSetUuid)
                                                         throws APIException

Description copied from interface: OrderSetService

Gets a specific OrderSet with the matched orderSet uuid.

Specified by:

getOrderSetByUuid in interface OrderSetService

Parameters:

orderSetUuid - Specifies a saved orderSet uuid.

Returns:

an orderSet

Throws:

APIException

See Also:

OrderSetService.getOrderSetByUuid(String)

getOrderSetMemberByUuid

@Transactional(readOnly=true)
public OrderSetMember getOrderSetMemberByUuid(String uuid)

Description copied from interface: OrderSetService

Get OrderSetMember by uuid

Specified by:

getOrderSetMemberByUuid in interface OrderSetService

Returns:

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

See Also:

OrderSetService.getOrderSetMemberByUuid(String)

getAllOrderSetAttributeTypes

@Transactional(readOnly=true)
public List<OrderSetAttributeType> getAllOrderSetAttributeTypes()

Description copied from interface: OrderSetService

Get all order set attribute types

Specified by:

getAllOrderSetAttributeTypes in interface OrderSetService

Returns:

all OrderSetAttributeTypes

See Also:

OrderSetService.getAllOrderSetAttributeTypes()

getOrderSetAttributeType

@Transactional(readOnly=true)
public OrderSetAttributeType getOrderSetAttributeType(Integer id)

Description copied from interface: OrderSetService

Get order set attribute type from the database by a given internal id

Specified by:

getOrderSetAttributeType in interface OrderSetService

Parameters:

id - specifies the set attribute type id

Returns:

the OrderSetAttributeType with the given internal id

See Also:

OrderSetService.getOrderSetAttributeType(java.lang.Integer)

getOrderSetAttributeTypeByUuid

@Transactional(readOnly=true)
public OrderSetAttributeType getOrderSetAttributeTypeByUuid(String uuid)

Description copied from interface: OrderSetService

Get order set attribute type by uuid

Specified by:

getOrderSetAttributeTypeByUuid in interface OrderSetService

Parameters:

uuid - specifies the order set attribute type uuid

Returns:

the OrderSetAttributeType with the given uuid

See Also:

OrderSetService.getOrderSetAttributeTypeByUuid(java.lang.String)

saveOrderSetAttributeType

@Transactional(readOnly=false)
public OrderSetAttributeType saveOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Description copied from interface: OrderSetService

Creates or updates the given order set attribute type

Specified by:

saveOrderSetAttributeType in interface OrderSetService

Parameters:

orderSetAttributeType - the order set attribute type to save

Returns:

the OrderSetAttributeType created/saved

See Also:

OrderSetService.saveOrderSetAttributeType(org.openmrs.OrderSetAttributeType)

retireOrderSetAttributeType

@Transactional(readOnly=false)
public OrderSetAttributeType retireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType,
                                                                                        String reason)

Description copied from interface: OrderSetService

Retires the given order set attribute type

Specified by:

retireOrderSetAttributeType in interface OrderSetService

Parameters:

orderSetAttributeType - specifies the order set attribute type to be retired

Returns:

the orderSetAttribute retired

See Also:

OrderSetService.retireOrderSetAttributeType(org.openmrs.OrderSetAttributeType, java.lang.String)

unretireOrderSetAttributeType

@Transactional(readOnly=false)
public OrderSetAttributeType unretireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Description copied from interface: OrderSetService

Restores an order set attribute type that was previous retired

Specified by:

unretireOrderSetAttributeType in interface OrderSetService

Parameters:

orderSetAttributeType - the order set attribute type to be un-retired

Returns:

the OrderSetAttributeType unretired

See Also:

OrderSetService.unretireOrderSetAttributeType(org.openmrs.OrderSetAttributeType)

purgeOrderSetAttributeType

@Transactional(readOnly=false)
public void purgeOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Description copied from interface: OrderSetService

Completely removes an order set attribute type

Specified by:

purgeOrderSetAttributeType in interface OrderSetService

Parameters:

orderSetAttributeType - the order set attribute type to be purged

See Also:

OrderSetService.purgeOrderSetAttributeType(org.openmrs.OrderSetAttributeType)

getOrderSetAttributeTypeByName

@Transactional(readOnly=true)
public OrderSetAttributeType getOrderSetAttributeTypeByName(String name)

Description copied from interface: OrderSetService

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

Specified by:

getOrderSetAttributeTypeByName in interface OrderSetService

Parameters:

name - fetches a given order set attribute type by name

Returns:

the OrderSetAttributeType with the specified name

See Also:

OrderSetService.getOrderSetAttributeTypeByName(java.lang.String)

getOrderSetAttributeByUuid

@Transactional(readOnly=true)
public OrderSetAttribute getOrderSetAttributeByUuid(String uuid)

Description copied from interface: OrderSetService

Get order set attribute by uuid

Specified by:

getOrderSetAttributeByUuid in interface OrderSetService

Parameters:

uuid - specifies the order set attribute uuid

Returns:

the OrderSetAttribute with the given uuid

See Also:

OrderSetService.getOrderSetAttributeByUuid(java.lang.String)