org.openmrs.api

Interface LocationService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

LocationServiceImpl

public interface LocationService
extends OpenmrsService

API methods for managing Locations

Example Usage:
List<Location> locations = Context.getLocationService().getAllLocations();

See Also:

Context, Location

Method Summary

Modifier and Type	Method and Description
String	getAddressTemplate() Returns the xml of default address template.
List<LocationAttributeType>	getAllLocationAttributeTypes()
List<Location>	getAllLocations() Returns all locations, includes retired locations.
List<Location>	getAllLocations(boolean includeRetired) Returns all locations.
List<LocationTag>	getAllLocationTags() Returns all location tags, includes retired location tags.
List<LocationTag>	getAllLocationTags(boolean includeRetired) Returns all location tags.
Integer	getCountOfLocations(String nameFragment, Boolean includeRetired) Return the number of all locations that start with the given name fragment, if the name fragment is null or an empty string, then the number of all locations will be returned
Location	getDefaultLocation() Returns the default location for this implementation.
Location	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	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
LocationAttribute	getLocationAttributeByUuid(String uuid)
LocationAttributeType	getLocationAttributeType(Integer id)
LocationAttributeType	getLocationAttributeTypeByName(String locationAttributeTypeName) Retrieves a LocationAttributeType object based on the name provided
LocationAttributeType	getLocationAttributeTypeByUuid(String uuid)
Location	getLocationByUuid(String uuid) Returns a location by uuid
List<Location>	getLocations(String nameFragment) Returns locations that match the beginning of the given string.
List<Location>	getLocations(String nameFragment, Location parent, Map<LocationAttributeType,Object> attributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments.
List<Location>	getLocationsByTag(LocationTag tag) Returns locations that contain the given tag.
List<Location>	getLocationsHavingAllTags(List<LocationTag> tags) Returns locations that are mapped to all given tags.
List<Location>	getLocationsHavingAnyTag(List<LocationTag> tags) Returns locations that are mapped to any of the given tags.
LocationTag	getLocationTag(Integer locationTagId) Returns a location tag given that locations primary key locationTagId.
LocationTag	getLocationTagByName(String tag) Returns a location tag given the location's exact name (tag).
LocationTag	getLocationTagByUuid(String uuid) Returns a location tag by uuid
List<LocationTag>	getLocationTags(String search) Returns location tags that match the beginning of the given string.
List<String>	getPossibleAddressValues(Address incomplete, String fieldName) Given an Address object, returns all the possible values for the specified AddressField.
List<Location>	getRootLocations(boolean includeRetired) Returns all root locations (i.e. those who have no parentLocation), optionally including retired ones.
void	purgeLocation(Location location) Completely remove a location from the database (not reversible) This method delegates to #purgeLocation(location, boolean) method
void	purgeLocationAttributeType(LocationAttributeType locationAttributeType) Completely removes a location attribute type from the database
void	purgeLocationTag(LocationTag tag) Completely remove a location tag from the database (not reversible).
Location	retireLocation(Location location, String reason) Retires the given location.
LocationAttributeType	retireLocationAttributeType(LocationAttributeType locationAttributeType, String reason) Retires the given location attribute type in the database
LocationTag	retireLocationTag(LocationTag tag, String reason) Retire the given location tag.
void	saveAddressTemplate(String xml) Saved default address template to global properties
Location	saveLocation(Location location) Save location to database (create if new or update if changed)
LocationAttributeType	saveLocationAttributeType(LocationAttributeType locationAttributeType) Creates or updates the given location attribute type in the database
LocationTag	saveLocationTag(LocationTag tag) Save location tag to database (create if new or update if changed)
void	setLocationDAO(LocationDAO dao) Set the data access object that the service will use to interact with the database.
Location	unretireLocation(Location location) Unretire the given location.
LocationAttributeType	unretireLocationAttributeType(LocationAttributeType locationAttributeType) Restores a location attribute type that was previous retired in the database
LocationTag	unretireLocationTag(LocationTag tag) Unretire the given location tag.

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

setLocationDAO

void setLocationDAO(LocationDAO dao)

Set the data access object that the service will use to interact with the database. This is set by spring in the applicationContext-service.xml file

Parameters:

dao -

saveLocation

@Authorized(value="Manage Locations")
Location saveLocation(Location location)
                                                     throws APIException

Save location to database (create if new or update if changed)

Parameters:

location - is the location to be saved to the database Should throw APIException if location has no name Should overwrite transient tag if tag with same name exists Should throw APIException if transient tag is not found Should return saved object Should remove location tag from location Should add location tag to location Should remove child location from location Should cascade save to child location from location Should update location successfully Should create location successfully

Throws:

APIException

getLocation

@Authorized(value="Get Locations")
Location getLocation(Integer locationId)
                                                 throws APIException

Returns a location given that locations primary key locationId A null value is returned if no location exists with this location.

Parameters:

locationId - integer primary key of the location to find

Returns:

Location object that has location.locationId = locationId passed in. Should return null when no location match given location id

Throws:

APIException

getLocation

@Authorized(value="Get Locations")
Location getLocation(String name)
                                                 throws APIException

Returns a location given the location's exact name A null value is returned if there is no location with this name

Parameters:

name - the exact name of the location to match on

Returns:

Location matching the name to Location.name Should return null when no location match given location name

Throws:

APIException

getDefaultLocation

@Authorized(value="Get Locations")
Location getDefaultLocation()
                                                        throws APIException

Returns the default location for this implementation.

Returns:

The default location for this implementation. Should return default location for the implementation Should return Unknown Location if the global property is something else that doesnot exist

Throws:

APIException

getLocationByUuid

@Authorized(value="Get Locations")
Location getLocationByUuid(String uuid)
                                                       throws APIException

Returns a location by uuid

Parameters:

uuid - is the uuid of the desired location

Returns:

location with the given uuid Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getLocationTagByUuid

@Authorized(value="Get Locations")
LocationTag getLocationTagByUuid(String uuid)
                                                             throws APIException

Returns a location tag by uuid

Parameters:

uuid - is the uuid of the desired location tag

Returns:

location tag with the given uuid Should find object given valid uuid Should return null if no object found with given uuid

Throws:

APIException

getAllLocations

@Authorized(value="Get Locations")
List<Location> getAllLocations()
                                                           throws APIException

Returns all locations, includes retired locations. This method delegates to the #getAllLocations(boolean) method

Returns:

locations that are in the database Should return all locations including retired

Throws:

APIException

getAllLocations

@Authorized(value="Get Locations")
List<Location> getAllLocations(boolean includeRetired)
                                                           throws APIException

Returns all locations.

Parameters:

includeRetired - whether or not to include retired locations Should return all locations when includeRetired is true Should return only unretired locations when includeRetires is false

Throws:

APIException

getLocations

@Authorized(value="Get Locations")
List<Location> getLocations(String nameFragment)
                                                        throws APIException

Returns locations that match the beginning of the given string. A null list will never be returned. An empty list will be returned if there are no locations. Search is case insensitive. matching this nameFragment

Parameters:

nameFragment - is the string used to search for locations Should return empty list when no location match the name fragment

Throws:

APIException

getLocations

@Authorized(value="Get Locations")
List<Location> getLocations(String nameFragment,
                                                               Location parent,
                                                               Map<LocationAttributeType,Object> attributeValues,
                                                               boolean includeRetired,
                                                               Integer start,
                                                               Integer length)
                                                        throws APIException

Gets the locations matching the specified arguments. A null list will never be returned. An empty list will be returned if there are no locations. Search is case insensitive. matching this nameFragment. If start and length are not specified, then all matches are returned.

Parameters:

nameFragment - is the string used to search for locations

parent - only return children of this parent

attributeValues - the attribute values

includeRetired - specifies if retired locations should also be returned

start - the beginning index

length - the number of matching locations to return

Returns:

the list of locations Should return empty list when no location has matching attribute values Should get locations having all matching attribute values

Throws:

APIException

Since:

1.10

getLocationsByTag

@Authorized(value="Get Locations")
List<Location> getLocationsByTag(LocationTag tag)
                                                             throws APIException

Returns locations that contain the given tag.

Parameters:

tag - LocationTag criterion Should get locations by tag Should return empty list when no locations has the given tag

Throws:

APIException

Since:

1.5

getLocationsHavingAllTags

@Authorized(value="Get Locations")
List<Location> getLocationsHavingAllTags(List<LocationTag> tags)
                                                                     throws APIException

Returns locations that are mapped to all given tags.

Parameters:

tags - Set of LocationTag criteria Should get locations having all tags Should return all unretired locations given an empty tag list

Throws:

APIException

Since:

1.5

getLocationsHavingAnyTag

@Authorized(value="Get Locations")
List<Location> getLocationsHavingAnyTag(List<LocationTag> tags)
                                                                    throws APIException

Returns locations that are mapped to any of the given tags.

Parameters:

tags - Set of LocationTag criteria Should get locations having any tag Should return empty list when no location has the given tags Should return empty list when given an empty tag list

Throws:

APIException

Since:

1.5

retireLocation

@Authorized(value="Manage Locations")
Location retireLocation(Location location,
                                                              String reason)
                                                       throws APIException

Retires the given location. This effectively removes the location from circulation or use.

Parameters:

location - location to be retired

reason - is the reason why the location is being retired Should retire location successfully

Throws:

APIException

unretireLocation

@Authorized(value="Manage Locations")
Location unretireLocation(Location location)
                                                         throws APIException

Unretire the given location. This restores a previously retired location back into circulation and use.

Parameters:

location -

Returns:

the newly unretired location

Throws:

APIException - Should unretire retired location

purgeLocation

@Authorized(value="Purge Locations")
void purgeLocation(Location location)
                                                 throws APIException

Completely remove a location from the database (not reversible) This method delegates to #purgeLocation(location, boolean) method

Parameters:

location - the Location to clean out of the database. Should delete location successfully

Throws:

APIException

saveLocationTag

@Authorized(value="Manage Location Tags")
LocationTag saveLocationTag(LocationTag tag)
                                                               throws APIException

Save location tag to database (create if new or update if changed)

Parameters:

tag - is the tag to be saved to the database Should throw APIException if tag has no name Should return saved object Should update location tag successfully Should create location tag successfully Should throw exception if tag name is null

Throws:

APIException

Since:

1.5

getLocationTag

@Authorized(value="Get Locations")
LocationTag getLocationTag(Integer locationTagId)
                                                       throws APIException

Returns a location tag given that locations primary key locationTagId. A null value is returned if no tag exists with this ID.

Parameters:

locationTagId - integer primary key of the location tag to find

Returns:

LocationTag object that has LocationTag.locationTagId = locationTagId passed in. Should return null when no location tag match given id

Throws:

APIException

Since:

1.5

getLocationTagByName

@Authorized(value="Get Locations")
LocationTag getLocationTagByName(String tag)
                                                             throws APIException

Returns a location tag given the location's exact name (tag). A null value is returned if there is no tag with this name.

Parameters:

tag - the exact name of the tag to match on

Returns:

LocationTag matching the name to LocationTag.tag Should get location tag by name Should return null when no location tag match given name

Throws:

APIException

Since:

1.5

getAllLocationTags

@Authorized(value="Get Locations")
List<LocationTag> getAllLocationTags()
                                                                 throws APIException

Returns all location tags, includes retired location tags. This method delegates to the #getAllLocationTags(boolean) method.

Returns:

location tags that are in the database Should return all location tags including retired

Throws:

APIException

Since:

1.5

getAllLocationTags

@Authorized(value="Get Locations")
List<LocationTag> getAllLocationTags(boolean includeRetired)
                                                                 throws APIException

Returns all location tags.

Parameters:

includeRetired - whether or not to include retired location tags Should return all location tags if includeRetired is true Should return only unretired location tags if includeRetired is false

Throws:

APIException

Since:

1.5

getLocationTags

@Authorized(value="Get Locations")
List<LocationTag> getLocationTags(String search)
                                                              throws APIException

Returns location tags that match the beginning of the given string. A null list will never be returned. An empty list will be returned if there are no tags. Search is case insensitive. matching this search

Parameters:

search - is the string used to search for tags Should return empty list when no location tag match given search string

Throws:

APIException

Since:

1.5

retireLocationTag

@Authorized(value="Manage Location Tags")
LocationTag retireLocationTag(LocationTag tag,
                                                                        String reason)
                                                                 throws APIException

Retire the given location tag. This effectively removes the tag from circulation or use.

Parameters:

tag - location tag to be retired

reason - is the reason why the location tag is being retired Should retire location tag successfully Should retire location tag with given reason

Throws:

APIException

Since:

1.5

unretireLocationTag

@Authorized(value="Manage Location Tags")
LocationTag unretireLocationTag(LocationTag tag)
                                                                   throws APIException

Unretire the given location tag. This restores a previously retired tag back into circulation and use.

Parameters:

tag -

Returns:

the newly unretired location tag

Throws:

APIException - Should unretire retired location tag

Since:

1.5

purgeLocationTag

@Authorized(value="Purge Location Tags")
void purgeLocationTag(LocationTag tag)
                                                        throws APIException

Completely remove a location tag from the database (not reversible).

Parameters:

tag - the LocationTag to clean out of the database. Should delete location tag

Throws:

APIException

Since:

1.5

getCountOfLocations

@Authorized(value="Get Locations")
Integer getCountOfLocations(String nameFragment,
                                                               Boolean includeRetired)

Return the number of all locations that start with the given name fragment, if the name fragment is null or an empty string, then the number of all locations will be returned

Parameters:

nameFragment - is the string used to search for locations

includeRetired - Specifies if retired locations should be counted or ignored

Returns:

the number of all locations starting with the given nameFragment

Since:

1.8

getRootLocations

@Authorized(value="Get Locations")
List<Location> getRootLocations(boolean includeRetired)

Returns all root locations (i.e. those who have no parentLocation), optionally including retired ones.

Parameters:

includeRetired -

Returns:

return all root locations depends on includeRetired Should return all root locations when includeRetired is true Should return only unretired root locations when includeRetired is false

Since:

1.9

getPossibleAddressValues

List<String> getPossibleAddressValues(Address incomplete,
                                      String fieldName)
                               throws APIException

Given an Address object, returns all the possible values for the specified AddressField. This method is not implemented in core, but is meant to overridden by implementing modules such as the Address Hierarchy module.

Parameters:

incomplete - the incomplete address

fieldName - the address field we are looking for possible values for

Returns:

a list of possible address values for the specified field Should return empty list if no possible address matches Should return null if method not implemented Should return null by default

Throws:

APIException

Since:

1.7.2

getAddressTemplate

@Authorized(value="Get Locations")
String getAddressTemplate()
                                                      throws APIException

Returns the xml of default address template.

Returns:

a string value of the default address template. If the GP is empty, the default template is returned

Throws:

APIException

Since:

1.9

See Also:

OpenmrsConstants.GLOBAL_PROPERTY_ADDRESS_TEMPLATE, OpenmrsConstants.DEFAULT_ADDRESS_TEMPLATE

saveAddressTemplate

@Authorized(value="Manage Address Templates")
void saveAddressTemplate(String xml)
                                                                throws APIException

Saved default address template to global properties

Parameters:

xml - is a string to be saved as address template Should throw APIException if the string is empty Should update default address template successfully Should create default address template successfully

Throws:

APIException

Since:

1.9

getAllLocationAttributeTypes

@Authorized(value="Get Location Attribute Types")
List<LocationAttributeType> getAllLocationAttributeTypes()

Returns:

all LocationAttributeTypes

Since:

1.9 Should return all location attribute types including retired ones

getLocationAttributeType

@Authorized(value="Get Location Attribute Types")
LocationAttributeType getLocationAttributeType(Integer id)

Parameters:

id -

Returns:

the LocationAttributeType with the given internal id

Since:

1.9 Should return the location attribute type with the given id Should return null if no location attribute type exists with the given id

getLocationAttributeTypeByUuid

@Authorized(value="Get Location Attribute Types")
LocationAttributeType getLocationAttributeTypeByUuid(String uuid)

Parameters:

uuid -

Returns:

the LocationAttributeType with the given uuid

Since:

1.9 Should return the location attribute type with the given uuid Should return null if no location attribute type exists with the given uuid

saveLocationAttributeType

@Authorized(value="Manage Location Attribute Types")
LocationAttributeType saveLocationAttributeType(LocationAttributeType locationAttributeType)

Creates or updates the given location attribute type in the database

Parameters:

locationAttributeType -

Returns:

the LocationAttributeType created/saved

Since:

1.9 Should create a new location attribute type Should edit an existing location attribute type

retireLocationAttributeType

@Authorized(value="Manage Location Attribute Types")
LocationAttributeType retireLocationAttributeType(LocationAttributeType locationAttributeType,
                                                                                                       String reason)

Retires the given location attribute type in the database

Parameters:

locationAttributeType -

Returns:

the locationAttribute retired

Since:

1.9 Should retire a location attribute type

unretireLocationAttributeType

@Authorized(value="Manage Location Attribute Types")
LocationAttributeType unretireLocationAttributeType(LocationAttributeType locationAttributeType)

Restores a location attribute type that was previous retired in the database

Parameters:

locationAttributeType -

Returns:

the LocationAttributeType unretired

Since:

1.9 Should unretire a retired location attribute type

purgeLocationAttributeType

@Authorized(value="Purge Location Attribute Types")
void purgeLocationAttributeType(LocationAttributeType locationAttributeType)

Completely removes a location attribute type from the database

Parameters:

locationAttributeType -

Since:

1.9 Should completely remove a location attribute type

getLocationAttributeByUuid

@Authorized(value="Get Locations")
LocationAttribute getLocationAttributeByUuid(String uuid)

Parameters:

uuid -

Returns:

the LocationAttribute with the given uuid

Since:

1.9 Should get the location attribute with the given uuid Should return null if no location attribute has the given uuid

getLocationAttributeTypeByName

@Authorized(value="Get Location Attribute Types")
LocationAttributeType getLocationAttributeTypeByName(String locationAttributeTypeName)

Retrieves a LocationAttributeType object based on the name provided

Parameters:

locationAttributeTypeName -

Returns:

the LocationAttributeType with the specified name

Since:

1.10.0 Should return the location attribute type with the specified name Should return null if no location attribute type exists with the specified name