org.openmrs.api

Class OrderContext

java.lang.Object

org.openmrs.api.OrderContext

public class OrderContext
extends java.lang.Object

Contains contextual information like the OrderType, CareSetting and any other custom attributes that are passed to the service layer when placing a new Order E.g you could add a user defined order number from a form that can be looked up from the context and returned by a custom OrderNumberGenerator

Since:

1.10

Constructor Summary

Constructors

Constructor and Description
OrderContext()

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the context attributes
java.lang.Object	getAttribute(java.lang.String attributeName) Gets the value of for the specified attribute name
CareSetting	getCareSetting()
java.util.Map<java.lang.String,java.lang.Object>	getContextAttributes()
OrderType	getOrderType()
void	removeAttribute(java.lang.String attributeName) Removes the attribute with the specified name
void	setAttribute(java.lang.String attributeName, java.lang.Object attributeValue) Adds the specified context attribute
void	setCareSetting(CareSetting careSetting)
void	setContextAttributes(java.util.Map<java.lang.String,java.lang.Object> contextAttributes)
void	setOrderType(OrderType orderType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderContext

public OrderContext()

Method Detail

getOrderType

public OrderType getOrderType()

Returns:

the orderType

setOrderType

public void setOrderType(OrderType orderType)

Parameters:

orderType - the OrderType to set

getCareSetting

public CareSetting getCareSetting()

Returns:

the careSetting

setCareSetting

public void setCareSetting(CareSetting careSetting)

Parameters:

careSetting - the CareSetting to set

getContextAttributes

public java.util.Map<java.lang.String,java.lang.Object> getContextAttributes()

Returns:

the contextAttributes

setContextAttributes

public void setContextAttributes(java.util.Map<java.lang.String,java.lang.Object> contextAttributes)

Parameters:

contextAttributes - the context attributes to set

getAttribute

public java.lang.Object getAttribute(java.lang.String attributeName)

Gets the value of for the specified attribute name

Parameters:

attributeName - the attribute name

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.Object attributeValue)

Adds the specified context attribute

Parameters:

attributeName - the attribute name

attributeValue - the attribute value

removeAttribute

public void removeAttribute(java.lang.String attributeName)

Removes the attribute with the specified name

Parameters:

attributeName - the attribute name

clear

public void clear()

Clears all the context attributes