VisitSearchCriteriaBuilder (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.parameter.VisitSearchCriteriaBuilder

```
public class VisitSearchCriteriaBuilder
extends Object
```
A builder class for constructing instances of VisitSearchCriteria. This builder allows for the flexible creation of VisitSearchCriteria objects by providing a simple interface to set various fields.

Since:

2.6.8, 2.7.0

Constructor Summary

Constructors
Constructor and Description

VisitSearchCriteriaBuilder()
Constructs a new VisitSearchCriteriaBuilder instance.

Constructors
Constructor and Description
`VisitSearchCriteriaBuilder()` Constructs a new `VisitSearchCriteriaBuilder` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VisitSearchCriteria`	`build()` Builds and returns a `VisitSearchCriteria` instance based on the current state of the builder.
`VisitSearchCriteriaBuilder`	`includeInactive(boolean includeInactive)` Sets whether inactive visits should be included in the search criteria.
`VisitSearchCriteriaBuilder`	`includeVoided(boolean includeVoided)` Sets whether voided visits should be included in the search criteria.
`VisitSearchCriteriaBuilder`	`indications(Collection<Concept> indications)` Sets the indications to include in the search criteria.
`VisitSearchCriteriaBuilder`	`locations(Collection<Location> locations)` Sets the locations to include in the search criteria.
`VisitSearchCriteriaBuilder`	`maxEndDatetime(Date maxEndDatetime)` Sets the maximum end datetime for visits to include in the search criteria.
`VisitSearchCriteriaBuilder`	`maxStartDatetime(Date maxStartDatetime)` Sets the maximum start datetime for visits to include in the search criteria.
`VisitSearchCriteriaBuilder`	`minEndDatetime(Date minEndDatetime)` Sets the minimum end datetime for visits to include in the search criteria.
`VisitSearchCriteriaBuilder`	`minStartDatetime(Date minStartDatetime)` Sets the minimum start datetime for visits to include in the search criteria.
`VisitSearchCriteriaBuilder`	`patient(Patient patient)` Sets a single patient to include in the search criteria.
`VisitSearchCriteriaBuilder`	`patients(Collection<Patient> patients)` Sets the patients to include in the search criteria.
`VisitSearchCriteriaBuilder`	`serializedAttributeValues(Map<VisitAttributeType,String> serializedAttributeValues)` Sets the serialized attribute values to filter visits by in the search criteria.
`VisitSearchCriteriaBuilder`	`visitTypes(Collection<VisitType> visitTypes)` Sets the visit types to include in the search criteria.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VisitSearchCriteriaBuilder
```
public VisitSearchCriteriaBuilder()
```
    Constructs a new VisitSearchCriteriaBuilder instance.
- Method Detail
  - visitTypes
```
public VisitSearchCriteriaBuilder visitTypes(Collection<VisitType> visitTypes)
```
    Sets the visit types to include in the search criteria.
    
    Parameters:
    
    visitTypes - the collection of VisitType to include.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - patients
```
public VisitSearchCriteriaBuilder patients(Collection<Patient> patients)
```
    Sets the patients to include in the search criteria.
    
    Parameters:
    
    patients - the collection of Patient to include.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - patient
```
public VisitSearchCriteriaBuilder patient(Patient patient)
```
    Sets a single patient to include in the search criteria.
    
    Parameters:
    
    patient - the Patient to include.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - locations
```
public VisitSearchCriteriaBuilder locations(Collection<Location> locations)
```
    Sets the locations to include in the search criteria.
    
    Parameters:
    
    locations - the collection of Location to include.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - indications
```
public VisitSearchCriteriaBuilder indications(Collection<Concept> indications)
```
    Sets the indications to include in the search criteria.
    
    Parameters:
    
    indications - the collection of Concept to include.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - minStartDatetime
```
public VisitSearchCriteriaBuilder minStartDatetime(Date minStartDatetime)
```
    Sets the minimum start datetime for visits to include in the search criteria.
    
    Parameters:
    
    minStartDatetime - the minimum start Date.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - maxStartDatetime
```
public VisitSearchCriteriaBuilder maxStartDatetime(Date maxStartDatetime)
```
    Sets the maximum start datetime for visits to include in the search criteria.
    
    Parameters:
    
    maxStartDatetime - the maximum start Date.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - minEndDatetime
```
public VisitSearchCriteriaBuilder minEndDatetime(Date minEndDatetime)
```
    Sets the minimum end datetime for visits to include in the search criteria.
    
    Parameters:
    
    minEndDatetime - the minimum end Date.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - maxEndDatetime
```
public VisitSearchCriteriaBuilder maxEndDatetime(Date maxEndDatetime)
```
    Sets the maximum end datetime for visits to include in the search criteria.
    
    Parameters:
    
    maxEndDatetime - the maximum end Date.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - serializedAttributeValues
```
public VisitSearchCriteriaBuilder serializedAttributeValues(Map<VisitAttributeType,String> serializedAttributeValues)
```
    Sets the serialized attribute values to filter visits by in the search criteria.
    
    Parameters:
    
    serializedAttributeValues - a map of VisitAttributeType to their corresponding serialized values.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - includeInactive
```
public VisitSearchCriteriaBuilder includeInactive(boolean includeInactive)
```
    Sets whether inactive visits should be included in the search criteria.
    
    Parameters:
    
    includeInactive - true to include inactive visits, false otherwise.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - includeVoided
```
public VisitSearchCriteriaBuilder includeVoided(boolean includeVoided)
```
    Sets whether voided visits should be included in the search criteria.
    
    Parameters:
    
    includeVoided - true to include voided visits, false otherwise.
    
    Returns:
    
    the current instance of VisitSearchCriteriaBuilder for method chaining.
  - build
```
public VisitSearchCriteria build()
```
    Builds and returns a VisitSearchCriteria instance based on the current state of the builder.
    
    Returns:
    
    a new instance of VisitSearchCriteria.

Class VisitSearchCriteriaBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisitSearchCriteriaBuilder

Method Detail

visitTypes

patients

patient

locations

indications

minStartDatetime

maxStartDatetime

minEndDatetime

maxEndDatetime

serializedAttributeValues

includeInactive

includeVoided

build