org.openmrs.api.db

Interface LocationDAO

All Known Implementing Classes:

HibernateLocationDAO

public interface LocationDAO

Location-related database functions

Method Summary

Modifier and Type	Method and Description
void	deleteLocation(Location location) Completely remove the location from the database.
void	deleteLocationTag(LocationTag tag) Completely remove the location tag from the database.
List<Location>	getAllLocations(boolean includeRetired) Get all locations
List<LocationTag>	getAllLocationTags(boolean includeRetired) Get all location tags
Integer	getCountOfLocations(String nameFragment, Boolean includeRetired)
Location	getLocation(Integer locationId) Get a location by locationId
Location	getLocation(String name) Get a location by name
Location	getLocationByUuid(String uuid)
List<Location>	getLocations(String nameFragment, boolean includeRetired, Integer start, Integer length) Returns a specified number of locations starting with a given string from the specified index
LocationTag	getLocationTag(Integer locationTagId) Get a location tag by locationTagId
LocationTag	getLocationTagByName(String tag) Get a location tag by name
LocationTag	getLocationTagByUuid(String uuid)
List<LocationTag>	getLocationTags(String search) Find all location tags with matching names.
Location	saveLocation(Location location) Create or update a location.
LocationTag	saveLocationTag(LocationTag tag) Create or update a location tag.
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set the Hibernate SessionFactory to connect to the database.

Method Detail

setSessionFactory

void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set the Hibernate SessionFactory to connect to the database.

Parameters:

sessionFactory -

saveLocation

Location saveLocation(Location location)

Create or update a location.

Parameters:

location - Location to save

Returns:

the saved Location

getLocation

Location getLocation(Integer locationId)

Get a location by locationId

Parameters:

locationId - Internal Integer identifier of the Location to get

Returns:

the requested Location

getLocation

Location getLocation(String name)

Get a location by name

Parameters:

name - String name of the Location to get

Returns:

the requested Location

getAllLocations

List<Location> getAllLocations(boolean includeRetired)

Get all locations

Parameters:

includeRetired - boolean - include retired locations as well?

Returns:

List object of all Locations, possibly including retired locations

getLocations

List<Location> getLocations(String nameFragment,
                            boolean includeRetired,
                            Integer start,
                            Integer length)
                     throws DAOException

Returns a specified number of locations starting with a given string from the specified index

Throws:

DAOException

See Also:

LocationService.getLocations(String, boolean, Integer, Integer)

deleteLocation

void deleteLocation(Location location)

Completely remove the location from the database.

Parameters:

location - Location object to delete

saveLocationTag

LocationTag saveLocationTag(LocationTag tag)

Create or update a location tag.

Parameters:

tag -

Returns:

the saved LocationTag

getLocationTag

LocationTag getLocationTag(Integer locationTagId)

Get a location tag by locationTagId

Parameters:

locationTagId - Internal Integer identifier of the tag to get

Returns:

the requested LocationTag

getLocationTagByName

LocationTag getLocationTagByName(String tag)

Get a location tag by name

Parameters:

tag - String representation of the LocationTag to get

Returns:

the requested LocationTag

getAllLocationTags

List<LocationTag> getAllLocationTags(boolean includeRetired)

Get all location tags

Parameters:

includeRetired - boolean - include retired tags as well?

Returns:

List object with all LocationTags, possibly included retired ones

getLocationTags

List<LocationTag> getLocationTags(String search)

Find all location tags with matching names.

Parameters:

search - name to search

Returns:

List with all matching LocationTags

deleteLocationTag

void deleteLocationTag(LocationTag tag)

Completely remove the location tag from the database.

Parameters:

tag - The LocationTag to delete

getLocationByUuid

Location getLocationByUuid(String uuid)

Parameters:

uuid - the uuid to look for

Returns:

location matching uuid

getLocationTagByUuid

LocationTag getLocationTagByUuid(String uuid)

Parameters:

uuid -

Returns:

getCountOfLocations

Integer getCountOfLocations(String nameFragment,
                            Boolean includeRetired)

See Also:

LocationService.getCountOfLocations(String, Boolean)