com.adobe.cq.address.api

Interface AddressProvider

public interface AddressProvider

Method Summary

Modifier and Type	Method and Description
Address	addAddress(ResourceResolver resolver, java.lang.String userID, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) Adds an address to the user.
Address	getAddress(ResourceResolver resolver, java.lang.String userID, java.lang.String path) Returns the address based on a path if represented in the repository or based on an ID uniquely identifying the address in an external provider.
java.util.Collection<Address>	getAddresses(ResourceResolver resolver, java.lang.String userID) Returns the addresses belonging to a user.
Address	getDefaultAddress(ResourceResolver resolver, java.lang.String userID) Returns the generic default address of the user.
Address	getDefaultAddress(ResourceResolver resolver, java.lang.String userID, java.lang.String type) Returns the default address that is defined for the given type (e.g.: billing, shipping.).
void	removeAddress(ResourceResolver resolver, java.lang.String userID, Address address, boolean autoSave) Removes the address.
void	setDefaultAddress(ResourceResolver resolver, java.lang.String userID, Address address, boolean autoSave) Sets the generic default address of the user.
void	setDefaultAddress(ResourceResolver resolver, java.lang.String userID, Address address, java.lang.String type, boolean autoSave) Sets the default address for the given type (e.g.: billing, shipping.).
Address	updateAddress(ResourceResolver resolver, java.lang.String userID, Address address, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) Updates the address.

Method Detail

getAddresses

java.util.Collection<Address> getAddresses(ResourceResolver resolver,
                                           java.lang.String userID)

Returns the addresses belonging to a user.

Parameters:

resolver - The resource resolver used to access the address book

userID - The user ID

Returns:

The addresses or null if there are none

getAddress

Address getAddress(ResourceResolver resolver,
                   java.lang.String userID,
                   java.lang.String path)

Returns the address based on a path if represented in the repository or based on an ID uniquely identifying the address in an external provider.

Parameters:

resolver - The resource resolver used to access the address book

userID - The user ID

path - The path identifying the address or an ID uniquely identifying the address in an external provider

Returns:

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

removeAddress

void removeAddress(ResourceResolver resolver,
                   java.lang.String userID,
                   Address address,
                   boolean autoSave)
            throws AddressException

Removes the address.

Parameters:

resolver - The resource resolver used to access the address book

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(ResourceResolver resolver,
                   java.lang.String userID,
                   java.util.Map<java.lang.String,java.lang.Object> properties,
                   boolean autoSave)
            throws AddressException

Adds an address to the user.

Parameters:

resolver - The resource resolver used to access the address book

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(ResourceResolver resolver,
                      java.lang.String userID,
                      Address address,
                      java.util.Map<java.lang.String,java.lang.Object> properties,
                      boolean autoSave)
               throws AddressException

Updates the address.

Parameters:

resolver - The resource resolver used to access the address book

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(ResourceResolver resolver,
                          java.lang.String userID)

Returns the generic default address of the user.

Parameters:

resolver - The resource resolver used to access the address book

userID - The user ID

getDefaultAddress

Address getDefaultAddress(ResourceResolver resolver,
                          java.lang.String userID,
                          java.lang.String type)

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

Parameters:

resolver - The resource resolver used to access the address book

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(ResourceResolver resolver,
                       java.lang.String userID,
                       Address address,
                       boolean autoSave)
                throws AddressException

Sets the generic default address of the user.

Parameters:

resolver - The resource resolver used to access the address book

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(ResourceResolver resolver,
                       java.lang.String userID,
                       Address address,
                       java.lang.String type,
                       boolean autoSave)
                throws AddressException

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

Parameters:

resolver - The resource resolver used to access the address book

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.