org.openmrs.parameter

Class OrderSearchCriteria

java.lang.Object

org.openmrs.parameter.OrderSearchCriteria

public class OrderSearchCriteria
extends Object

The search parameter object for orders. A convenience interface for building instances is provided by OrderSearchCriteriaBuilder.

Since:

2.2

See Also:

OrderSearchCriteriaBuilder

Constructor Summary

Constructors

Constructor and Description
OrderSearchCriteria(Patient patient, CareSetting careSetting, Collection<Concept> concepts, Collection<OrderType> orderTypes, Date activatedOnOrBeforeDate, Date activatedOnOrAfterDate, boolean isStopped, Date autoExpireOnOrBeforeDate, Date canceledOrExpiredOnOrBeforeDate, Order.Action action, Order.FulfillerStatus fulfillerStatus, Boolean includeNullFulfillerStatus, boolean excludeCanceledAndExpired, boolean excludeDiscontinueOrders, boolean includeVoided) Deprecated.
OrderSearchCriteria(Patient patient, CareSetting careSetting, Collection<Concept> concepts, Collection<OrderType> orderTypes, String accessionNumber, String orderNumber, Date activatedOnOrBeforeDate, Date activatedOnOrAfterDate, boolean isStopped, Date autoExpireOnOrBeforeDate, Date canceledOrExpiredOnOrBeforeDate, Order.Action action, Order.FulfillerStatus fulfillerStatus, Boolean includeNullFulfillerStatus, boolean excludeCanceledAndExpired, boolean excludeDiscontinueOrders, boolean includeVoided) Instead of calling this constructor directly, it is recommended to use OrderSearchCriteriaBuilder.
OrderSearchCriteria(Patient patient, CareSetting careSetting, Collection<Concept> concepts, Collection<OrderType> orderTypes, String accessionNumber, String orderNumber, Date activatedOnOrBeforeDate, Date activatedOnOrAfterDate, boolean isStopped, Date autoExpireOnOrBeforeDate, Date canceledOrExpiredOnOrBeforeDate, Order.Action action, Order.FulfillerStatus fulfillerStatus, Boolean includeNullFulfillerStatus, boolean excludeCanceledAndExpired, boolean excludeDiscontinueOrders, boolean includeVoided, Visit visit)

Method Summary

Modifier and Type	Method and Description
String	getAccessionNumber()
Order.Action	getAction()
Date	getActivatedOnOrAfterDate()
Date	getActivatedOnOrBeforeDate()
Date	getAutoExpireOnOrBeforeDate()
Date	getCanceledOrExpiredOnOrBeforeDate()
CareSetting	getCareSetting()
Collection<Concept>	getConcepts()
boolean	getExcludeCanceledAndExpired()
boolean	getExcludeDiscontinueOrders()
Order.FulfillerStatus	getFulfillerStatus()
Boolean	getIncludeNullFulfillerStatus()
boolean	getIncludeVoided()
String	getOrderNumber()
Collection<OrderType>	getOrderTypes()
Patient	getPatient()
Visit	getVisit()
boolean	isStopped()

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderSearchCriteria

public OrderSearchCriteria(Patient patient,
                           CareSetting careSetting,
                           Collection<Concept> concepts,
                           Collection<OrderType> orderTypes,
                           String accessionNumber,
                           String orderNumber,
                           Date activatedOnOrBeforeDate,
                           Date activatedOnOrAfterDate,
                           boolean isStopped,
                           Date autoExpireOnOrBeforeDate,
                           Date canceledOrExpiredOnOrBeforeDate,
                           Order.Action action,
                           Order.FulfillerStatus fulfillerStatus,
                           Boolean includeNullFulfillerStatus,
                           boolean excludeCanceledAndExpired,
                           boolean excludeDiscontinueOrders,
                           boolean includeVoided)

Instead of calling this constructor directly, it is recommended to use OrderSearchCriteriaBuilder.

Parameters:

patient - the patient the order is for

careSetting - the care setting to match on

concepts - the concepts to match on; if not specified, matches on all concepts

orderTypes - the order types to match on; if not specified, matches all order types

accessionNumber - to match on; performs exact match if specified

orderNumber - to match on; performs exact match if specifed

activatedOnOrBeforeDate - orders must have dateActivated on or before this date

activatedOnOrAfterDate - orders must have dateActivated on or after this date

includeVoided - whether to include the voided orders or not

OrderSearchCriteria

public OrderSearchCriteria(Patient patient,
                           CareSetting careSetting,
                           Collection<Concept> concepts,
                           Collection<OrderType> orderTypes,
                           String accessionNumber,
                           String orderNumber,
                           Date activatedOnOrBeforeDate,
                           Date activatedOnOrAfterDate,
                           boolean isStopped,
                           Date autoExpireOnOrBeforeDate,
                           Date canceledOrExpiredOnOrBeforeDate,
                           Order.Action action,
                           Order.FulfillerStatus fulfillerStatus,
                           Boolean includeNullFulfillerStatus,
                           boolean excludeCanceledAndExpired,
                           boolean excludeDiscontinueOrders,
                           boolean includeVoided,
                           Visit visit)

OrderSearchCriteria

@Deprecated
public OrderSearchCriteria(Patient patient,
                                       CareSetting careSetting,
                                       Collection<Concept> concepts,
                                       Collection<OrderType> orderTypes,
                                       Date activatedOnOrBeforeDate,
                                       Date activatedOnOrAfterDate,
                                       boolean isStopped,
                                       Date autoExpireOnOrBeforeDate,
                                       Date canceledOrExpiredOnOrBeforeDate,
                                       Order.Action action,
                                       Order.FulfillerStatus fulfillerStatus,
                                       Boolean includeNullFulfillerStatus,
                                       boolean excludeCanceledAndExpired,
                                       boolean excludeDiscontinueOrders,
                                       boolean includeVoided)

Deprecated.

(Legacy constructor, before addition of Order Number and Accession Number fields) Instead of calling this constructor directly, it is recommended to use OrderSearchCriteriaBuilder.

Parameters:

patient - the patient the order is for

careSetting - the care setting to match on

concepts - the concepts to match on; if not specified, matches on all concepts

orderTypes - the order types to match on; if not specified, matches all order types

activatedOnOrBeforeDate - orders must have dateActivated on or before this date

activatedOnOrAfterDate - orders must have dateActivated on or after this date

includeVoided - whether to include the voided orders or not

Method Detail

getPatient

public Patient getPatient()

Returns:

the patient the order is for

getCareSetting

public CareSetting getCareSetting()

Returns:

the care setting to match on

getConcepts

public Collection<Concept> getConcepts()

Returns:

the concepts defining the order must be in this collection

getOrderTypes

public Collection<OrderType> getOrderTypes()

Returns:

the order types to match on must be in this collection

getVisit

public Visit getVisit()

Returns:

the visit the order is for

Since:

2.7.0

getAccessionNumber

public String getAccessionNumber()

Returns:

the accession number to match on; must be case-insensitive exact-match

Since:

2.3.1

getOrderNumber

public String getOrderNumber()

Returns:

the order number to match on; must be case-insensitive exact-match

Since:

2.3.1

getActivatedOnOrBeforeDate

public Date getActivatedOnOrBeforeDate()

Returns:

orders must have dateActivated on or before this date

getActivatedOnOrAfterDate

public Date getActivatedOnOrAfterDate()

Returns:

orders must have dateActivated on or after this date

isStopped

public boolean isStopped()

Returns:

orders must have dateStopped on or before this date

getAutoExpireOnOrBeforeDate

public Date getAutoExpireOnOrBeforeDate()

Returns:

orders must have autoExpireDate on or before this date

getCanceledOrExpiredOnOrBeforeDate

public Date getCanceledOrExpiredOnOrBeforeDate()

Returns:

orders that are canceled or have autoExpireDate on or before this date

getAction

public Order.Action getAction()

Returns:

orders must match the action

getFulfillerStatus

public Order.FulfillerStatus getFulfillerStatus()

Returns:

orders must match the fulfillerstatus

getIncludeNullFulfillerStatus

public Boolean getIncludeNullFulfillerStatus()

Returns:

include(OR) orders with fulfiller_status = null

getExcludeCanceledAndExpired

public boolean getExcludeCanceledAndExpired()

getExcludeDiscontinueOrders

public boolean getExcludeDiscontinueOrders()

getIncludeVoided

public boolean getIncludeVoided()

Returns:

whether to include the voided orders or not