org.openmrs.util

Class LocationUtility

java.lang.Object

org.openmrs.util.LocationUtility

All Implemented Interfaces:

GlobalPropertyListener

public class LocationUtility
extends Object
implements GlobalPropertyListener

A utility class for working with locations

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
LocationUtility()

Method Summary

Modifier and Type	Method and Description
static Location	getDefaultLocation() Gets the system default location specified as a global property.
static Location	getUserDefaultLocation() Convenience method that returns the default location of the authenticated user.
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(String propertyName) Called after a global property is deleted
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationUtility

public LocationUtility()

Method Detail

getDefaultLocation

public static Location getDefaultLocation()

Gets the system default location specified as a global property.

Returns:

default location object.

Should:

return the updated defaultLocation when the value of the global property is changed

getUserDefaultLocation

public static Location getUserDefaultLocation()

Convenience method that returns the default location of the authenticated user. It should return the user's specified location from the user properties if any is set.

Should:

return the user specified location if any is set

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

See Also:

GlobalPropertyListener.globalPropertyChanged(org.openmrs.GlobalProperty)

globalPropertyDeleted

public void globalPropertyDeleted(String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted

See Also:

GlobalPropertyListener.globalPropertyDeleted(java.lang.String)

supportsPropertyName

public boolean supportsPropertyName(String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name

See Also:

GlobalPropertyListener.supportsPropertyName(java.lang.String)