Uses of Class
org.openmrs.Location

Packages that use Location

Package	Description
org.openmrs	These classes represent the core domain objects for the OpenMRS project.
org.openmrs.api	The primary OpenMRS API interfaces.
org.openmrs.api.context	This package describes the context framework through which authentication is performed and services provided for the OpenMRS system.
org.openmrs.api.db	OpenMRS database layer interfaces.
org.openmrs.api.db.hibernate	Resources for Hibernate ORM.
org.openmrs.api.impl
org.openmrs.customdatatype.datatype
org.openmrs.parameter
org.openmrs.propertyeditor
org.openmrs.util	Shared utilities for OpenMRS classes

Uses of Location in org.openmrs

Fields in org.openmrs declared as Location

Modifier and Type	Field and Description
protected Location	Obs.location

Methods in org.openmrs that return Location

Modifier and Type	Method and Description
Location	Visit.getLocation()
Location	PatientProgram.getLocation()
Location	PatientIdentifier.getLocation()
Location	Obs.getLocation()
Location	MedicationDispense.getLocation()
Location	LocationAttribute.getLocation()
Location	Encounter.getLocation()
Location	Location.getParentLocation()
Location	Location.hydrate(String locationId)

Methods in org.openmrs that return types with arguments of type Location

Modifier and Type	Method and Description
List<Location>	Location.findPossibleValues(String searchText) Deprecated.
Set<Location>	Location.getChildLocations()
Set<Location>	Location.getChildLocations(boolean includeRetired) Returns all childLocations where child.locationId = this.locationId.
Set<Location>	Location.getDescendantLocations(boolean includeRetired) Returns the descendant locations.
List<Location>	Location.getPossibleValues() Deprecated.

Methods in org.openmrs with parameters of type Location

Modifier and Type	Method and Description
void	Location.addChildLocation(Location child)
static Boolean	Location.isInHierarchy(Location location, Location root) Checks whether 'location' is a member of the tree starting at 'root'.
void	Location.removeChildLocation(Location child)
void	Visit.setLocation(Location location)
void	PatientProgram.setLocation(Location location)
void	PatientIdentifier.setLocation(Location location)
void	Obs.setLocation(Location location)
void	MedicationDispense.setLocation(Location location)
void	LocationAttribute.setLocation(Location location)
void	Encounter.setLocation(Location location)
void	Location.setParentLocation(Location parentLocationId)

Method parameters in org.openmrs with type arguments of type Location

Modifier and Type	Method and Description
void	Location.setChildLocations(Set<Location> childLocations)

Constructors in org.openmrs with parameters of type Location

Constructor and Description
Obs(Person person, Concept question, Date obsDatetime, Location location) Required parameters constructor A value is also required, but that can be one of: valueCoded, valueDrug, valueNumeric, or valueText
PatientIdentifier(String identifier, PatientIdentifierType type, Location location) Convenience constructor for creating a basic identifier

Uses of Location in org.openmrs.api

Methods in org.openmrs.api that return Location

Modifier and Type	Method and Description
Location	LocationService.getDefaultLocation() Returns the default location for this implementation.
Location	LocationService.getLocation(Integer locationId) Returns a location given that locations primary key locationId A null value is returned if no location exists with this location.
Location	LocationService.getLocation(String name) Returns a location given the location's exact name A null value is returned if there is no location with this name
Location	LocationService.getLocationByUuid(String uuid) Returns a location by uuid
Location	LocationService.retireLocation(Location location, String reason) Retires the given location.
Location	LocationService.saveLocation(Location location) Save location to database (create if new or update if changed)
Location	LocationService.unretireLocation(Location location) Unretire the given location.

Methods in org.openmrs.api that return types with arguments of type Location

Modifier and Type	Method and Description
List<Location>	LocationService.getAllLocations() Returns all locations, includes retired locations.
List<Location>	LocationService.getAllLocations(boolean includeRetired) Returns all locations.
List<Location>	LocationService.getLocations(String nameFragment) Returns locations that match the beginning of the given string.
List<Location>	LocationService.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,Object> attributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments.
List<Location>	LocationService.getLocationsByTag(LocationTag tag) Returns locations that contain the given tag.
List<Location>	LocationService.getLocationsHavingAllTags(List<LocationTag> tags) Returns locations that are mapped to all given tags.
List<Location>	LocationService.getLocationsHavingAnyTag(List<LocationTag> tags) Returns locations that are mapped to any of the given tags.
List<Location>	LocationService.getRootLocations(boolean includeRetired) Returns all root locations (i.e. those who have no parentLocation), optionally including retired ones.

Methods in org.openmrs.api with parameters of type Location

Modifier and Type	Method and Description
List<Encounter>	EncounterService.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Deprecated. As of 2.0, replaced by EncounterService.getEncounters(EncounterSearchCriteria)
List<Location>	LocationService.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,Object> attributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments.
void	LocationService.purgeLocation(Location location) Completely remove a location from the database (not reversible) This method delegates to #purgeLocation(location, boolean) method
Location	LocationService.retireLocation(Location location, String reason) Retires the given location.
Location	LocationService.saveLocation(Location location) Save location to database (create if new or update if changed)
Location	LocationService.unretireLocation(Location location) Unretire the given location.

Method parameters in org.openmrs.api with type arguments of type Location

Modifier and Type	Method and Description
Integer	ObsService.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs) This method fetches the count of observations according to the criteria in the given arguments.
Integer	ObsService.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
Integer	ObsService.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<Visit> visits, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsService.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs) This method fetches observations according to the criteria in the given arguments.
List<Obs>	ObsService.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsService.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<PatientIdentifier>	PatientService.getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred) Get all patientIdentifiers that match all of the given criteria Voided identifiers are not returned
List<Visit>	VisitService.getVisits(Collection<VisitType> visitTypes, Collection<Patient> patients, Collection<Location> locations, Collection<Concept> indications, Date minStartDatetime, Date maxStartDatetime, Date minEndDatetime, Date maxEndDatetime, Map<VisitAttributeType,Object> attributeValues, boolean includeInactive, boolean includeVoided) Gets the visits matching the specified arguments

Uses of Location in org.openmrs.api.context

Methods in org.openmrs.api.context that return Location

Modifier and Type	Method and Description
Location	UserContext.getLocation()

Methods in org.openmrs.api.context with parameters of type Location

Modifier and Type	Method and Description
void	UserContext.setLocation(Location location)

Uses of Location in org.openmrs.api.db

Methods in org.openmrs.api.db that return Location

Modifier and Type	Method and Description
Location	LocationDAO.getLocation(Integer locationId) Get a location by locationId
Location	LocationDAO.getLocation(String name) Get a location by name
Location	LocationDAO.getLocationByUuid(String uuid)
Location	EncounterDAO.getSavedEncounterLocation(Encounter encounter) Gets the location of the encounter
Location	LocationDAO.saveLocation(Location location) Create or update a location.

Methods in org.openmrs.api.db that return types with arguments of type Location

Modifier and Type	Method and Description
List<Location>	LocationDAO.getAllLocations(boolean includeRetired) Get all locations
List<Location>	LocationDAO.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,String> serializedAttributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments
List<Location>	LocationDAO.getLocationsHavingAllTags(List<LocationTag> locationTagIdList) Get locations that have all the location tags specified.
List<Location>	LocationDAO.getRootLocations(boolean includeRetired)

Methods in org.openmrs.api.db with parameters of type Location

Modifier and Type	Method and Description
void	LocationDAO.deleteLocation(Location location) Completely remove the location from the database.
List<Location>	LocationDAO.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,String> serializedAttributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments
Location	LocationDAO.saveLocation(Location location) Create or update a location.

Method parameters in org.openmrs.api.db with type arguments of type Location

Modifier and Type	Method and Description
Long	ObsDAO.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, List<ConceptName> valueCodedNameAnswers, boolean includeVoidedObs, String accessionNumber)
Long	ObsDAO.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, List<ConceptName> valueCodedNameAnswers, List<Visit> visits, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsDAO.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsDAO.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sortList, List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<PatientIdentifier>	PatientDAO.getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)
List<Visit>	VisitDAO.getVisits(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) Gets the visits matching the specified arguments

Uses of Location in org.openmrs.api.db.hibernate

Methods in org.openmrs.api.db.hibernate that return Location

Modifier and Type	Method and Description
Location	HibernateLocationDAO.getLocation(Integer locationId)
Location	HibernateLocationDAO.getLocation(String name)
Location	HibernateLocationDAO.getLocationByUuid(String uuid)
Location	HibernateEncounterDAO.getSavedEncounterLocation(Encounter encounter)
Location	HibernateLocationDAO.saveLocation(Location location)

Methods in org.openmrs.api.db.hibernate that return types with arguments of type Location

Modifier and Type	Method and Description
List<Location>	HibernateLocationDAO.getAllLocations(boolean includeRetired)
List<Location>	HibernateLocationDAO.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,String> serializedAttributeValues, boolean includeRetired, Integer start, Integer length)
List<Location>	HibernateLocationDAO.getLocationsHavingAllTags(List<LocationTag> tags)
List<Location>	HibernateLocationDAO.getRootLocations(boolean includeRetired)

Methods in org.openmrs.api.db.hibernate with parameters of type Location

Modifier and Type	Method and Description
void	HibernateLocationDAO.deleteLocation(Location location)
List<Location>	HibernateLocationDAO.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,String> serializedAttributeValues, boolean includeRetired, Integer start, Integer length)
Location	HibernateLocationDAO.saveLocation(Location location)

Method parameters in org.openmrs.api.db.hibernate with type arguments of type Location

Modifier and Type	Method and Description
static <AT extends AttributeType> List<javax.persistence.criteria.Predicate>	HibernateUtil.getAttributePredicate(javax.persistence.criteria.CriteriaBuilder cb, javax.persistence.criteria.Root<Location> locationRoot, Map<AT,String> serializedAttributeValues) Constructs a list of predicates for attribute value criteria for use in a JPA Criteria query.
Long	HibernateObsDAO.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, List<ConceptName> valueCodedNameAnswers, boolean includeVoidedObs, String accessionNumber)
Long	HibernateObsDAO.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, List<ConceptName> valueCodedNameAnswers, List<Visit> visits, boolean includeVoidedObs, String accessionNumber)
List<Obs>	HibernateObsDAO.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sortList, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	HibernateObsDAO.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sortList, List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<PatientIdentifier>	HibernatePatientDAO.getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)
List<Visit>	HibernateVisitDAO.getVisits(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)

Uses of Location in org.openmrs.api.impl

Methods in org.openmrs.api.impl that return Location

Modifier and Type	Method and Description
Location	LocationServiceImpl.getDefaultLocation()
Location	LocationServiceImpl.getLocation(Integer locationId)
Location	LocationServiceImpl.getLocation(String name)
Location	LocationServiceImpl.getLocationByUuid(String uuid)
Location	LocationServiceImpl.retireLocation(Location location, String reason)
Location	LocationServiceImpl.saveLocation(Location location)
Location	LocationServiceImpl.unretireLocation(Location location)

Methods in org.openmrs.api.impl that return types with arguments of type Location

Modifier and Type	Method and Description
List<Location>	LocationServiceImpl.getAllLocations()
List<Location>	LocationServiceImpl.getAllLocations(boolean includeRetired)
List<Location>	LocationServiceImpl.getLocations(String nameFragment)
List<Location>	LocationServiceImpl.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,Object> attributeValues, boolean includeRetired, Integer start, Integer length)
List<Location>	LocationServiceImpl.getLocationsByTag(LocationTag tag)
List<Location>	LocationServiceImpl.getLocationsHavingAllTags(List<LocationTag> tags)
List<Location>	LocationServiceImpl.getLocationsHavingAnyTag(List<LocationTag> tags)
List<Location>	LocationServiceImpl.getRootLocations(boolean includeRetired)

Methods in org.openmrs.api.impl with parameters of type Location

Modifier and Type	Method and Description
List<Encounter>	EncounterServiceImpl.getEncounters(Patient who, Location loc, Date fromDate, Date toDate, Collection<Form> enteredViaForms, Collection<EncounterType> encounterTypes, Collection<Provider> providers, Collection<VisitType> visitTypes, Collection<Visit> visits, boolean includeVoided) Deprecated. As of 2.0, replaced by EncounterServiceImpl.getEncounters(EncounterSearchCriteria)
List<Location>	LocationServiceImpl.getLocations(String nameFragment, Location parent, Map<LocationAttributeType,Object> attributeValues, boolean includeRetired, Integer start, Integer length)
void	LocationServiceImpl.purgeLocation(Location location)
Location	LocationServiceImpl.retireLocation(Location location, String reason)
Location	LocationServiceImpl.saveLocation(Location location)
Location	LocationServiceImpl.unretireLocation(Location location)

Method parameters in org.openmrs.api.impl with type arguments of type Location

Modifier and Type	Method and Description
Integer	ObsServiceImpl.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs)
Integer	ObsServiceImpl.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
Integer	ObsServiceImpl.getObservationCount(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<Visit> visits, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsServiceImpl.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs)
List<Obs>	ObsServiceImpl.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<Obs>	ObsServiceImpl.getObservations(List<Person> whom, List<Encounter> encounters, List<Concept> questions, List<Concept> answers, List<OpenmrsConstants.PERSON_TYPE> personTypes, List<Location> locations, List<String> sort, List<Visit> visits, Integer mostRecentN, Integer obsGroupId, Date fromDate, Date toDate, boolean includeVoidedObs, String accessionNumber)
List<PatientIdentifier>	PatientServiceImpl.getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)
List<Visit>	VisitServiceImpl.getVisits(Collection<VisitType> visitTypes, Collection<Patient> patients, Collection<Location> locations, Collection<Concept> indications, Date minStartDatetime, Date maxStartDatetime, Date minEndDatetime, Date maxEndDatetime, Map<VisitAttributeType,Object> attributeValues, boolean includeInactive, boolean includeVoided)

Uses of Location in org.openmrs.customdatatype.datatype

Methods in org.openmrs.customdatatype.datatype that return Location

Modifier and Type	Method and Description
Location	LocationDatatype.deserialize(String uuid)

Uses of Location in org.openmrs.parameter

Methods in org.openmrs.parameter that return Location

Modifier and Type	Method and Description
Location	EncounterSearchCriteria.getLocation()

Methods in org.openmrs.parameter that return types with arguments of type Location

Modifier and Type	Method and Description
Collection<Location>	VisitSearchCriteria.getLocations()

Methods in org.openmrs.parameter with parameters of type Location

Modifier and Type	Method and Description
EncounterSearchCriteriaBuilder	EncounterSearchCriteriaBuilder.setLocation(Location location)

Method parameters in org.openmrs.parameter with type arguments of type Location

Modifier and Type	Method and Description
VisitSearchCriteriaBuilder	VisitSearchCriteriaBuilder.locations(Collection<Location> locations) Sets the locations to include in the search criteria.
void	VisitSearchCriteria.setLocations(Collection<Location> locations) Sets the collection of locations to be included in the search criteria.

Constructors in org.openmrs.parameter with parameters of type Location

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.

Constructor parameters in org.openmrs.parameter with type arguments of type Location

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.

Uses of Location in org.openmrs.propertyeditor

Methods in org.openmrs.propertyeditor that return Location

Modifier and Type	Method and Description
protected Location	LocationEditor.getObjectById(Integer id)
protected Location	LocationEditor.getObjectByUuid(String uuid)

Uses of Location in org.openmrs.util

Methods in org.openmrs.util that return Location

Modifier and Type	Method and Description
static Location	LocationUtility.getDefaultLocation() Gets the system default location specified as a global property.
static Location	LocationUtility.getUserDefaultLocation() Convenience method that returns the default location of the authenticated user.

Methods in org.openmrs.util with parameters of type Location

Modifier and Type	Method and Description
static void	LocationUtility.setDefaultLocation(Location defaultLocation)