org.openmrs.api

Interface OrderSetService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

OrderSetServiceImpl

public interface OrderSetService
extends OpenmrsService

Contains methods pertaining to creating/deleting/voiding Order Sets.

Since:

1.12

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 orderSetAttributeTypeName) 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 interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setOrderSetDAO

void setOrderSetDAO(OrderSetDAO dao)

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

Parameters:

dao - The data access object to use

saveOrderSet

@Authorized(value="Manage Order Sets")
OrderSet saveOrderSet(OrderSet orderSet)
                                                      throws APIException

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.

Parameters:

orderSet - the OrderSet to save

Returns:

the OrderSet that was saved

Throws:

APIException

getOrderSets

@Authorized(value="Get Order Sets")
List<OrderSet> getOrderSets(boolean includeRetired)
                                                         throws APIException

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

Parameters:

includeRetired - Specifies whether retired orders should be included or not

Returns:

list of OrderSets matching the parameters

Throws:

APIException

getOrderSet

@Authorized(value="Get Order Sets")
OrderSet getOrderSet(Integer orderSetId)
                                                  throws APIException

Gets a specific OrderSet with the matched orderSet Id.

Parameters:

orderSetId - Specifies a saved orderSet id.

Returns:

OrderSet

Throws:

APIException

getOrderSetByUuid

@Authorized(value="Get Order Sets")
OrderSet getOrderSetByUuid(String orderSetUuid)
                                                        throws APIException

Gets a specific OrderSet with the matched orderSet uuid.

Parameters:

orderSetUuid - Specifies a saved orderSet uuid.

Returns:

an orderSet

Throws:

APIException

retireOrderSet

@Authorized(value="Manage Order Sets")
OrderSet retireOrderSet(OrderSet orderSet,
                                                               String retireReason)
                                                        throws APIException

Retires and OrderSet, with matched OrderSet

Parameters:

orderSet - Specifies the OrderSet to be retired

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

Returns:

an orderSet

Throws:

APIException

unretireOrderSet

@Authorized(value="Manage Order Sets")
OrderSet unretireOrderSet(OrderSet orderSet)
                                                          throws APIException

UnRetires and OrderSet, with matched OrderSet

Parameters:

orderSet - Specifies the OrderSet to be retired

Returns:

an orderSet

Throws:

APIException

getOrderSetMemberByUuid

@Authorized(value="Get Order Sets")
OrderSetMember getOrderSetMemberByUuid(String uuid)

Get OrderSetMember by uuid

Parameters:

uuid -

Returns:

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

getOrderSetAttributeByUuid

@Authorized(value="Get Order Sets")
OrderSetAttribute getOrderSetAttributeByUuid(String uuid)

Get order set attribute by uuid

Parameters:

uuid - specifies the order set attribute uuid

Returns:

the OrderSetAttribute with the given uuid

Since:

2.4.0

getAllOrderSetAttributeTypes

@Authorized(value="Get Order Set Attribute Types")
List<OrderSetAttributeType> getAllOrderSetAttributeTypes()

Get all order set attribute types

Returns:

all OrderSetAttributeTypes

Since:

2.4.0

getOrderSetAttributeType

@Authorized(value="Get Order Set Attribute Types")
OrderSetAttributeType getOrderSetAttributeType(Integer id)

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

Parameters:

id - specifies the set attribute type id

Returns:

the OrderSetAttributeType with the given internal id

Since:

2.4.0

getOrderSetAttributeTypeByUuid

@Authorized(value="Get Order Set Attribute Types")
OrderSetAttributeType getOrderSetAttributeTypeByUuid(String uuid)

Get order set attribute type by uuid

Parameters:

uuid - specifies the order set attribute type uuid

Returns:

the OrderSetAttributeType with the given uuid

Since:

2.4.0

saveOrderSetAttributeType

@Authorized(value="Manage Order Set Attribute Types")
OrderSetAttributeType saveOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Creates or updates the given order set attribute type

Parameters:

orderSetAttributeType - the order set attribute type to save

Returns:

the OrderSetAttributeType created/saved

Since:

2.4.0

retireOrderSetAttributeType

@Authorized(value="Manage Order Set Attribute Types")
OrderSetAttributeType retireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType,
                                                                                                        String reason)

Retires the given order set attribute type

Parameters:

orderSetAttributeType - specifies the order set attribute type to be retired

Returns:

the orderSetAttribute retired

Since:

2.4.0

unretireOrderSetAttributeType

@Authorized(value="Manage Order Set Attribute Types")
OrderSetAttributeType unretireOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Restores an order set attribute type that was previous retired

Parameters:

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

Returns:

the OrderSetAttributeType unretired

Since:

2.4.0

purgeOrderSetAttributeType

@Authorized(value="Purge Order Set Attribute Types")
void purgeOrderSetAttributeType(OrderSetAttributeType orderSetAttributeType)

Completely removes an order set attribute type

Parameters:

orderSetAttributeType - the order set attribute type to be purged

Since:

2.4.0

getOrderSetAttributeTypeByName

@Authorized(value="Get Order Set Attribute Types")
OrderSetAttributeType getOrderSetAttributeTypeByName(String orderSetAttributeTypeName)

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

Parameters:

orderSetAttributeTypeName - fetches a given order set attribute type by name

Returns:

the OrderSetAttributeType with the specified name

Since:

2.4.0