com.adobe.cq.address.api.location

Interface LocationManager

Deprecated.

As of AEM 6.4

@Deprecated
public interface LocationManager

The LocationManager provides methods to retrieve, update, create and update locations.

Method Summary

Modifier and Type	Method and Description
Location	addLocation(java.lang.String groupPath, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) Deprecated. Adds a location to the location group.
Location	getLocation(java.lang.String path) Deprecated. Returns the location based on its path.
java.util.List<Location>	getLocations(java.lang.String groupPath) Deprecated. Returns the locations belonging to a location group.
java.util.List<Location>	rankLocations(java.lang.String groupPath, Coordinates origin, boolean geocode) Deprecated. Returns a sorted list of locations ranked by closest distance to origin coordinates.
void	removeLocation(Location location, boolean autoSave) Deprecated. Removes the location.
Location	updateLocation(Location location, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) Deprecated. Updates the location.

Method Detail

getLocations

java.util.List<Location> getLocations(java.lang.String groupPath)

Deprecated.

Returns the locations belonging to a location group.

Parameters:

groupPath - The location group path

Returns:

The addresses or null if there are none

rankLocations

java.util.List<Location> rankLocations(java.lang.String groupPath,
                                       Coordinates origin,
                                       boolean geocode)

Deprecated.

Returns a sorted list of locations ranked by closest distance to origin coordinates.

Parameters:

groupPath - The location group path

origin - Latitude and longitude coordinates to rank locations against

geocode - Flag that indicates if each location should be geocoded if it does not have stored coordinates

Returns:

ranked list of locations

getLocation

Location getLocation(java.lang.String path)

Deprecated.

Returns the location based on its path.

Parameters:

path - The location path

Returns:

The location or null if it does not exist

removeLocation

void removeLocation(Location location,
                    boolean autoSave)
             throws AddressException

Deprecated.

Removes the location.

Parameters:

location - The location address

autoSave - If true the operation is persisted

Throws:

AddressException - when the operation fails.

java.lang.IllegalArgumentException - when the location is null

addLocation

Location addLocation(java.lang.String groupPath,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean autoSave)
              throws AddressException

Deprecated.

Adds a location to the location group.

Parameters:

groupPath - The location group path

properties - The location properties

autoSave - If true the operation is persisted

Returns:

The new location

Throws:

AddressException - when the operation fails.

updateLocation

Location updateLocation(Location location,
                        java.util.Map<java.lang.String,java.lang.Object> properties,
                        boolean autoSave)
                 throws AddressException

Deprecated.

Updates the location.

Parameters:

location - The location address

properties - The location properties

autoSave - If true the operation is persisted

Returns:

The updated location

Throws:

AddressException - when the operation fails.

java.lang.IllegalArgumentException - when the location is null