org.openmrs.parameter

Class VisitSearchCriteria

java.lang.Object

org.openmrs.parameter.VisitSearchCriteria

public class VisitSearchCriteria
extends Object

The VisitSearchCriteria class encapsulates the criteria used for searching visits in the system. It includes various fields that allow filtering visits based on different parameters such as visit type, patient, location, and date ranges. It also provides options to include or exclude inactive and voided visits.

Since:

2.6.8, 2.7.0

Constructor Summary

Constructors

Constructor and Description

VisitSearchCriteria(Collection<VisitType> visitTypes, Collection<Patient> patients, Collection<Location> locations, Collection<Concept> indications, Date minStartDatetime, Date maxStartDatetime, Date minEndDatetime, Date maxEndDatetime, Map<VisitAttributeType,String> serializedAttributeValues, boolean includeInactive, boolean includeVoided) Constructs a VisitSearchCriteria with the specified parameters.

Method Summary

Modifier and Type	Method and Description
Collection<Concept>	getIndications()
Collection<Location>	getLocations()
Date	getMaxEndDatetime()
Date	getMaxStartDatetime()
Date	getMinEndDatetime()
Date	getMinStartDatetime()
Collection<Patient>	getPatients()
Map<VisitAttributeType,String>	getSerializedAttributeValues()
Collection<VisitType>	getVisitTypes()
boolean	isIncludeInactive()
boolean	isIncludeVoided()
void	setIncludeInactive(boolean includeInactive) Sets whether inactive visits should be included in the search criteria.
void	setIncludeVoided(boolean includeVoided) Sets whether voided visits should be included in the search criteria.
void	setIndications(Collection<Concept> indications) Sets the collection of indications to be included in the search criteria.
void	setLocations(Collection<Location> locations) Sets the collection of locations to be included in the search criteria.
void	setMaxEndDatetime(Date maxEndDatetime) Sets the maximum end datetime to be included in the search criteria.
void	setMaxStartDatetime(Date maxStartDatetime) Sets the maximum start datetime to be included in the search criteria.
void	setMinEndDatetime(Date minEndDatetime) Sets the minimum end datetime to be included in the search criteria.
void	setMinStartDatetime(Date minStartDatetime) Sets the minimum start datetime to be included in the search criteria.
void	setPatients(Collection<Patient> patients) Sets the collection of patients to be included in the search criteria.
void	setSerializedAttributeValues(Map<VisitAttributeType,String> serializedAttributeValues) Sets the map of serialized attribute values to be included in the search criteria.
void	setVisitTypes(Collection<VisitType> visitTypes) Sets the collection of visit types to be included in the search criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisitSearchCriteria

public VisitSearchCriteria(Collection<VisitType> visitTypes,
                           Collection<Patient> patients,
                           Collection<Location> locations,
                           Collection<Concept> indications,
                           Date minStartDatetime,
                           Date maxStartDatetime,
                           Date minEndDatetime,
                           Date maxEndDatetime,
                           Map<VisitAttributeType,String> serializedAttributeValues,
                           boolean includeInactive,
                           boolean includeVoided)

Constructs a VisitSearchCriteria with the specified parameters. Instead of calling this constructor directly, it is recommended to use VisitSearchCriteriaBuilder.

Parameters:

visitTypes - the types of visits to include in the search

patients - the patients associated with the visits to include in the search

locations - the locations associated with the visits to include in the search

indications - the indications associated with the visits to include in the search

minStartDatetime - the minimum start date of visits to include in the search

maxStartDatetime - the maximum start date of visits to include in the search

minEndDatetime - the minimum end date of visits to include in the search

maxEndDatetime - the maximum end date of visits to include in the search

serializedAttributeValues - a map of serialized attribute values to filter visits by

includeInactive - whether to include inactive visits in the search

includeVoided - whether to include voided visits in the search

Method Detail

getVisitTypes

public Collection<VisitType> getVisitTypes()

Returns:

the collection of visit types included in the search criteria.

setVisitTypes

public void setVisitTypes(Collection<VisitType> visitTypes)

Sets the collection of visit types to be included in the search criteria.

Parameters:

visitTypes - the collection of visit types to set.

getPatients

public Collection<Patient> getPatients()

Returns:

the collection of patients included in the search criteria.

setPatients

public void setPatients(Collection<Patient> patients)

Sets the collection of patients to be included in the search criteria.

Parameters:

patients - the collection of patients to set.

getLocations

public Collection<Location> getLocations()

Returns:

the collection of locations included in the search criteria.

setLocations

public void setLocations(Collection<Location> locations)

Sets the collection of locations to be included in the search criteria.

Parameters:

locations - the collection of locations to set.

getIndications

public Collection<Concept> getIndications()

Returns:

the collection of indications included in the search criteria.

setIndications

public void setIndications(Collection<Concept> indications)

Sets the collection of indications to be included in the search criteria.

Parameters:

indications - the collection of indications to set.

getMinStartDatetime

public Date getMinStartDatetime()

Returns:

the minimum start datetime included in the search criteria.

setMinStartDatetime

public void setMinStartDatetime(Date minStartDatetime)

Sets the minimum start datetime to be included in the search criteria.

Parameters:

minStartDatetime - the minimum start datetime to set.

getMaxStartDatetime

public Date getMaxStartDatetime()

Returns:

the maximum start datetime included in the search criteria.

setMaxStartDatetime

public void setMaxStartDatetime(Date maxStartDatetime)

Sets the maximum start datetime to be included in the search criteria.

Parameters:

maxStartDatetime - the maximum start datetime to set.

getMinEndDatetime

public Date getMinEndDatetime()

Returns:

the minimum end datetime included in the search criteria.

setMinEndDatetime

public void setMinEndDatetime(Date minEndDatetime)

Sets the minimum end datetime to be included in the search criteria.

Parameters:

minEndDatetime - the minimum end datetime to set.

getMaxEndDatetime

public Date getMaxEndDatetime()

Returns:

the maximum end datetime included in the search criteria.

setMaxEndDatetime

public void setMaxEndDatetime(Date maxEndDatetime)

Sets the maximum end datetime to be included in the search criteria.

Parameters:

maxEndDatetime - the maximum end datetime to set.

getSerializedAttributeValues

public Map<VisitAttributeType,String> getSerializedAttributeValues()

Returns:

a map of serialized attribute values included in the search criteria.

setSerializedAttributeValues

public void setSerializedAttributeValues(Map<VisitAttributeType,String> serializedAttributeValues)

Sets the map of serialized attribute values to be included in the search criteria.

Parameters:

serializedAttributeValues - the map of serialized attribute values to set.

isIncludeInactive

public boolean isIncludeInactive()

Returns:

true if inactive visits are included in the search criteria, false otherwise.

setIncludeInactive

public void setIncludeInactive(boolean includeInactive)

Sets whether inactive visits should be included in the search criteria.

Parameters:

includeInactive - true to include inactive visits, false otherwise.

isIncludeVoided

public boolean isIncludeVoided()

Returns:

true if voided visits are included in the search criteria, false otherwise.

setIncludeVoided

public void setIncludeVoided(boolean includeVoided)

Sets whether voided visits should be included in the search criteria.

Parameters:

includeVoided - true to include voided visits, false otherwise.