com.adobe.cq.address.api

Interface AddressManager

public interface AddressManager

The AddressManager provides methods to retrieve, update, create and update addresses.

Method Summary

Methods

Modifier and Type	Method and Description
Address	addAddress(String userID, Map<String,Object> properties, boolean autoSave) Adds an address to the user.
Address	getAddress(String userID, String path) Returns the address based on its path.
Collection<Address>	getAddresses(String userID) Returns the addresses belonging to a user.
Address	getDefaultAddress(String userID) Returns the generic default address of the user.
Address	getDefaultAddress(String userID, String type) Returns the default address that is defined for the given type (e.g.: billing, shipping.).
void	removeAddress(String userID, Address address, boolean autoSave) Removes the address.
void	setDefaultAddress(String userID, Address address, boolean autoSave) Sets the generic default address of the user.
void	setDefaultAddress(String userID, Address address, String type, boolean autoSave) Sets the default address for the given type (e.g.: billing, shipping.).
Address	updateAddress(String userID, Address address, Map<String,Object> properties, boolean autoSave) Updates the address.

Method Detail

getAddresses

Collection<Address> getAddresses(String userID)

Returns the addresses belonging to a user.

Parameters:

userID - The user ID

Returns:

The addresses or null if there are none

getAddress

Address getAddress(String userID,
                 String path)

Returns the address based on its path.

Parameters:

userID - The user ID

path - The address path

Returns:

The address or null if it does not exist or if it does not belong to the user

removeAddress

void removeAddress(String userID,
                 Address address,
                 boolean autoSave)
                   throws AddressException

Removes the address.

Parameters:

userID - The user ID

address - The address

autoSave - If true the operation is persisted

Throws:

AddressException - when the address does not belong to the user or when the operation fails.

addAddress

Address addAddress(String userID,
                 Map<String,Object> properties,
                 boolean autoSave)
                   throws AddressException

Adds an address to the user.

Parameters:

userID - The user ID

properties - The address properties

autoSave - If true the operation is persisted

Returns:

The new address

Throws:

AddressException - when the operation fails.

updateAddress

Address updateAddress(String userID,
                    Address address,
                    Map<String,Object> properties,
                    boolean autoSave)
                      throws AddressException

Updates the address.

Parameters:

userID - The user ID

address - The address

properties - The address properties

autoSave - If true the operation is persisted

Returns:

The updated address

Throws:

AddressException - when the address does not belong to the user or when the operation fails.

getDefaultAddress

Address getDefaultAddress(String userID)

Returns the generic default address of the user.

Parameters:

userID - The user ID

getDefaultAddress

Address getDefaultAddress(String userID,
                        String type)

Returns the default address that is defined for the given type (e.g.: billing, shipping.).

Parameters:

userID - The user ID

type - The type of the default address. E.g.: billing, shipping. If the type is null or empty, the generic default address is returned.

setDefaultAddress

void setDefaultAddress(String userID,
                     Address address,
                     boolean autoSave)
                       throws AddressException

Sets the generic default address of the user.

Parameters:

userID - The user ID

address - The address

autoSave - If true the operation is persisted

Throws:

AddressException - when the address does not belong to the user or when the operation fails.

setDefaultAddress

void setDefaultAddress(String userID,
                     Address address,
                     String type,
                     boolean autoSave)
                       throws AddressException

Sets the default address for the given type (e.g.: billing, shipping.).

Parameters:

userID - The user ID

address - The address

type - The type of the default address. E.g.: billing, shipping. If the given type is null or empty, the generic default address is set.

autoSave - If true the operation is persisted

Throws:

AddressException - when the address does not belong to the user or when the operation fails.