org.openmrs

Class OrderGroup

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.BaseCustomizableData<OrderGroupAttribute>

org.openmrs.OrderGroup

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, Customizable<OrderGroupAttribute>, OpenmrsData, OpenmrsObject, Voidable

public class OrderGroup
extends BaseCustomizableData<OrderGroupAttribute>

Contains a group of Orders that are ordered together within a single encounter,often driven by an OrderSet. Not all orders in an encounter need to be grouped this way, only those that have a specific connection to each other (e.g. several orders that together make up a treatment protocol for some diagnosis could be grouped).

Since:

1.12

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
OrderGroup()

Method Summary

Modifier and Type	Method and Description
void	addOrder(Order order) Adds a new order to the existing list of orders
void	addOrder(Order order, Integer position) Adds a new order to the existing list of orders.
void	addOrders(List<Order> orders) Adds Orders to existing Order list
Encounter	getEncounter() Gets the encounter
Integer	getId()
Set<OrderGroup>	getNestedOrderGroups() Gets the nested order groups to other order groups, to maintain linkages between groups and support group nesting
Integer	getOrderGroupId() Gets the orderGroupId
Concept	getOrderGroupReason() Gets the order group reason which denotes the reason why the group was ordered
List<Order>	getOrders() Gets the orders
OrderSet	getOrderSet() Gets the orderSet
OrderGroup	getParentOrderGroup() Gets the parent order group to maintain linkages between groups and support group nesting
Patient	getPatient() Gets the patient
OrderGroup	getPreviousOrderGroup() Gets the previous order group to other order groups, to maintain linkages between groups and support group nesting
void	setEncounter(Encounter encounter) Sets the encounter
void	setId(Integer id)
void	setNestedOrderGroups(Set<OrderGroup> nestedOrderGroups) Sets the nested order groups to other order groups, to maintain linkages between groups and support group nesting.
void	setOrderGroupId(Integer orderGroupId) Sets the orderGroupId
void	setOrderGroupReason(Concept orderGroupReason) Sets the order group reason which denotes the reason why the group was ordered
void	setOrders(List<Order> orders) Sets the orders
void	setOrderSet(OrderSet orderSet) Sets the orderSet
void	setParentOrderGroup(OrderGroup parentOrderGroup) Sets the parent order group to maintain linkages between groups and support group nesting
void	setPatient(Patient patient) Sets the patient
void	setPreviousOrderGroup(OrderGroup previousOrderGroup) Sets the previous order group to other order groups, to maintain linkages between groups and support group nesting

Methods inherited from class org.openmrs.BaseCustomizableData

addAttribute, getActiveAttributes, getActiveAttributes, getAttributes, setAttribute, setAttributes

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

OrderGroup

public OrderGroup()

Method Detail

getOrderGroupId

public Integer getOrderGroupId()

Gets the orderGroupId

Returns:

the orderGroupId

setOrderGroupId

public void setOrderGroupId(Integer orderGroupId)

Sets the orderGroupId

Parameters:

orderGroupId - the orderGroupId to set

getPatient

public Patient getPatient()

Gets the patient

Returns:

the patient

setPatient

public void setPatient(Patient patient)

Sets the patient

Parameters:

patient - the patient to set

getEncounter

public Encounter getEncounter()

Gets the encounter

Returns:

the encounter

setEncounter

public void setEncounter(Encounter encounter)

Sets the encounter

Parameters:

encounter - the encounter to set

getOrders

public List<Order> getOrders()

Gets the orders

Returns:

the orders

setOrders

public void setOrders(List<Order> orders)

Sets the orders

Parameters:

orders - the orders to set

addOrder

public void addOrder(Order order)

Adds a new order to the existing list of orders

Parameters:

order - the new order to be added

addOrders

public void addOrders(List<Order> orders)

Adds Orders to existing Order list

Parameters:

orders -

Since:

2.2

addOrder

public void addOrder(Order order,
                     Integer position)

Adds a new order to the existing list of orders. The sortWeight for the order is auto calculated based on the given position.

Parameters:

order - the new order to be added

position - the position where the order has to be added

getOrderSet

public OrderSet getOrderSet()

Gets the orderSet

Returns:

the orderSet

setOrderSet

public void setOrderSet(OrderSet orderSet)

Sets the orderSet

Parameters:

orderSet - the orderSet to set

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

getParentOrderGroup

public OrderGroup getParentOrderGroup()

Gets the parent order group to maintain linkages between groups and support group nesting

Returns:

the parent order group

Since:

2.4.0

setParentOrderGroup

public void setParentOrderGroup(OrderGroup parentOrderGroup)

Sets the parent order group to maintain linkages between groups and support group nesting

Parameters:

parentOrderGroup - the parent order group to set.

Since:

2.4.0

getOrderGroupReason

public Concept getOrderGroupReason()

Gets the order group reason which denotes the reason why the group was ordered

Returns:

the order group reason

Since:

2.4.0

setOrderGroupReason

public void setOrderGroupReason(Concept orderGroupReason)

Sets the order group reason which denotes the reason why the group was ordered

Parameters:

orderGroupReason, - the order group reason to set

Since:

2.4.0

getPreviousOrderGroup

public OrderGroup getPreviousOrderGroup()

Gets the previous order group to other order groups, to maintain linkages between groups and support group nesting

Parameters:

returns - the previous order group

Since:

2.4.0

setPreviousOrderGroup

public void setPreviousOrderGroup(OrderGroup previousOrderGroup)

Sets the previous order group to other order groups, to maintain linkages between groups and support group nesting

Parameters:

previousOrderGroup - The previous order group to set

Since:

2.4.0

getNestedOrderGroups

public Set<OrderGroup> getNestedOrderGroups()

Gets the nested order groups to other order groups, to maintain linkages between groups and support group nesting

Parameters:

returns - the nested order groups

Since:

2.4.0

setNestedOrderGroups

public void setNestedOrderGroups(Set<OrderGroup> nestedOrderGroups)

Sets the nested order groups to other order groups, to maintain linkages between groups and support group nesting.

Parameters:

nestedOrderGroup - The nested order groups to set

Since:

2.4.0