@Deprecated
public interface AddressManager
AddressManager
provides methods to retrieve, update, create and update addresses.Modifier and Type | Method and Description |
---|---|
Address |
addAddress(java.lang.String userID,
java.util.Map<java.lang.String,java.lang.Object> properties,
boolean autoSave)
Deprecated.
Adds an address to the user.
|
Address |
getAddress(java.lang.String userID,
java.lang.String path)
Deprecated.
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(java.lang.String userID)
Deprecated.
Returns the addresses belonging to a user.
|
Address |
getDefaultAddress(java.lang.String userID)
Deprecated.
Returns the generic default address of the user.
|
Address |
getDefaultAddress(java.lang.String userID,
java.lang.String type)
Deprecated.
Returns the default address that is defined for the given type (e.g.: billing, shipping.).
|
void |
removeAddress(java.lang.String userID,
Address address,
boolean autoSave)
Deprecated.
Removes the address.
|
void |
setDefaultAddress(java.lang.String userID,
Address address,
boolean autoSave)
Deprecated.
Sets the generic default address of the user.
|
void |
setDefaultAddress(java.lang.String userID,
Address address,
java.lang.String type,
boolean autoSave)
Deprecated.
Sets the default address for the given type (e.g.: billing, shipping.).
|
Address |
updateAddress(java.lang.String userID,
Address address,
java.util.Map<java.lang.String,java.lang.Object> properties,
boolean autoSave)
Deprecated.
Updates the address.
|
java.util.Collection<Address> getAddresses(java.lang.String userID)
userID
- The user IDnull
if there are noneAddress getAddress(java.lang.String userID, java.lang.String path)
userID
- The user IDpath
- The path identifying the address or an ID uniquely identifying the address in an external providernull
if it does not exist or if it does not belong to the uservoid removeAddress(java.lang.String userID, Address address, boolean autoSave) throws AddressException
userID
- The user IDaddress
- The addressautoSave
- If true
the operation is persistedAddressException
- when the address does not belong to the user or when the operation fails.Address addAddress(java.lang.String userID, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) throws AddressException
userID
- The user IDproperties
- The address propertiesautoSave
- If true
the operation is persistedAddressException
- when the operation fails.Address updateAddress(java.lang.String userID, Address address, java.util.Map<java.lang.String,java.lang.Object> properties, boolean autoSave) throws AddressException
userID
- The user IDaddress
- The addressproperties
- The address propertiesautoSave
- If true
the operation is persistedAddressException
- when the address does not belong to the user or when the operation fails.Address getDefaultAddress(java.lang.String userID)
userID
- The user IDAddress getDefaultAddress(java.lang.String userID, java.lang.String type)
userID
- The user IDtype
- The type of the default address. E.g.: billing, shipping.
If the type is null
or empty, the generic default address is returned.void setDefaultAddress(java.lang.String userID, Address address, boolean autoSave) throws AddressException
userID
- The user IDaddress
- The addressautoSave
- If true
the operation is persistedAddressException
- when the address does not belong to the user or when the operation fails.void setDefaultAddress(java.lang.String userID, Address address, java.lang.String type, boolean autoSave) throws AddressException
userID
- The user IDaddress
- The addresstype
- 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 persistedAddressException
- when the address does not belong to the user or when the operation fails.Copyright © 2010 - 2020 Adobe. All Rights Reserved