org.openmrs.parameter

Class EncounterSearchCriteria

java.lang.Object

org.openmrs.parameter.EncounterSearchCriteria

public class EncounterSearchCriteria
extends Object

The search parameter object for encounters. A convenience interface for building instances is provided by EncounterSearchCriteriaBuilder.

Since:

1.12

See Also:

EncounterSearchCriteriaBuilder

Constructor Summary

Constructors

Constructor and Description
EncounterSearchCriteria(Patient patient, Location location, Date fromDate, Date toDate, Date dateChanged, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Instead of calling this constructor directly, it is recommended to use EncounterSearchCriteriaBuilder.

Method Summary

Modifier and Type	Method and Description
Date	getDateChanged()
Collection<EncounterType>	getEncounterTypes()
Collection<Form>	getEnteredViaForms()
Date	getFromDate()
boolean	getIncludeVoided()
Location	getLocation()
Patient	getPatient()
Collection<Provider>	getProviders()
Date	getToDate()
Collection<Visit>	getVisits()
Collection<VisitType>	getVisitTypes()

Methods inherited from class java.lang.Object

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

Constructor Detail

EncounterSearchCriteria

public EncounterSearchCriteria(Patient patient,
                               Location location,
                               Date fromDate,
                               Date toDate,
                               Date dateChanged,
                               Collection<Form> enteredViaForms,
                               Collection<EncounterType> encounterTypes,
                               Collection<Provider> providers,
                               Collection<VisitType> visitTypes,
                               Collection<Visit> visits,
                               boolean includeVoided)

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

Parameters:

patient - the patient the encounter is for

location - the location this encounter took place

fromDate - the minimum date (inclusive) the encounter took place

toDate - the maximum date (exclusive) the encounter took place

dateChanged - the minimum date the encounter was changed

enteredViaForms - the form that entered this encounter must be in this collection

encounterTypes - the type of the encounter must be in this collection

providers - the provider of the encounter must be in this collection

visitTypes - the visit types of the encounter must be in this collection

visits - the visits of the encounter must be in this collection

includeVoided - whether to include the voided encounters or not

Method Detail

getPatient

public Patient getPatient()

Returns:

the patient the encounter is for

getLocation

public Location getLocation()

Returns:

the location this encounter took place

getFromDate

public Date getFromDate()

Returns:

the minimum date (inclusive) this encounter took place

getToDate

public Date getToDate()

Returns:

the maximum date (exclusive) this encounter took place

getDateChanged

public Date getDateChanged()

Returns:

the minimum date this encounter was changed

getEnteredViaForms

public Collection<Form> getEnteredViaForms()

Returns:

the form that entered this encounter must be in this collection

getEncounterTypes

public Collection<EncounterType> getEncounterTypes()

Returns:

the type of encounter must be in this list

getProviders

public Collection<Provider> getProviders()

Returns:

the provider of this encounter must be in this list

getVisitTypes

public Collection<VisitType> getVisitTypes()

Returns:

the visit types of this encounter must be in this list

getVisits

public Collection<Visit> getVisits()

Returns:

the visits of this encounter must be in this list

getIncludeVoided

public boolean getIncludeVoided()

Returns:

whether to include the voided encounters or not