org.openmrs.parameter

Class EncounterSearchCriteriaBuilder

java.lang.Object

org.openmrs.parameter.EncounterSearchCriteriaBuilder

public class EncounterSearchCriteriaBuilder
extends Object

A convenience builder for EncounterSearchCriteria. Create a builder, set its properties to desired values and finally call createEncounterSearchCriteria() to create the actual search criteria instance.

See Also:

EncounterSearchCriteria

Constructor Summary

Constructors

Constructor and Description
EncounterSearchCriteriaBuilder()

Method Summary

Modifier and Type	Method and Description
EncounterSearchCriteria	createEncounterSearchCriteria() Create an EncounterSearchCriteria with the properties of this builder instance.
EncounterSearchCriteriaBuilder	setDateChanged(Date dateChanged)
EncounterSearchCriteriaBuilder	setEncounterTypes(Collection<EncounterType> encounterTypes)
EncounterSearchCriteriaBuilder	setEnteredViaForms(Collection<Form> enteredViaForms)
EncounterSearchCriteriaBuilder	setFromDate(Date fromDate)
EncounterSearchCriteriaBuilder	setIncludeVoided(boolean includeVoided)
EncounterSearchCriteriaBuilder	setLocation(Location location)
EncounterSearchCriteriaBuilder	setPatient(Patient patient)
EncounterSearchCriteriaBuilder	setProviders(Collection<Provider> providers)
EncounterSearchCriteriaBuilder	setToDate(Date toDate)
EncounterSearchCriteriaBuilder	setVisits(Collection<Visit> visits)
EncounterSearchCriteriaBuilder	setVisitTypes(Collection<VisitType> visitTypes)

Methods inherited from class java.lang.Object

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

Constructor Detail

EncounterSearchCriteriaBuilder

public EncounterSearchCriteriaBuilder()

Method Detail

setPatient

public EncounterSearchCriteriaBuilder setPatient(Patient patient)

Parameters:

patient - the patient the encounter is for

Returns:

this builder instance

setLocation

public EncounterSearchCriteriaBuilder setLocation(Location location)

Parameters:

location - the location the encounter took place

Returns:

this builder instance

setFromDate

public EncounterSearchCriteriaBuilder setFromDate(Date fromDate)

Parameters:

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

Returns:

this builder instance

setToDate

public EncounterSearchCriteriaBuilder setToDate(Date toDate)

Parameters:

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

Returns:

this builder instance

setDateChanged

public EncounterSearchCriteriaBuilder setDateChanged(Date dateChanged)

Parameters:

dateChanged - the minimum date the encounter was changed

Returns:

this builder instance

setEnteredViaForms

public EncounterSearchCriteriaBuilder setEnteredViaForms(Collection<Form> enteredViaForms)

Parameters:

enteredViaForms - the form that entered the encounter must be in this collection. This search parameter is omitted if the set is null or empty.

Returns:

this builder instance

setEncounterTypes

public EncounterSearchCriteriaBuilder setEncounterTypes(Collection<EncounterType> encounterTypes)

Parameters:

encounterTypes - the type of the encounter must be in this collection. This search parameter is omitted if the set is null or empty.

Returns:

this builder instance

setProviders

public EncounterSearchCriteriaBuilder setProviders(Collection<Provider> providers)

Parameters:

providers - the provider of the encounter must be in this collection. This search parameter is omitted if the set is null or empty.

Returns:

this builder instance

setVisitTypes

public EncounterSearchCriteriaBuilder setVisitTypes(Collection<VisitType> visitTypes)

Parameters:

visitTypes - the visit types of the encounter must be in this collection. This search parameter is omitted if the set is null or empty.

Returns:

this builder instance

setVisits

public EncounterSearchCriteriaBuilder setVisits(Collection<Visit> visits)

Parameters:

visits - the visits of the encounter must be in this collection. This search parameter is omitted if the set is null or empty.

Returns:

this builder instance

setIncludeVoided

public EncounterSearchCriteriaBuilder setIncludeVoided(boolean includeVoided)

Parameters:

includeVoided - whether to include the voided encounters or not

Returns:

this builder instance

createEncounterSearchCriteria

public EncounterSearchCriteria createEncounterSearchCriteria()

Create an EncounterSearchCriteria with the properties of this builder instance.

Returns:

a new search criteria instance