de.hybris.platform.commercefacades.user

Interface UserFacade

All Known Implementing Classes:

ChineseUserFacade, DefaultUserFacade

public interface UserFacade

User facade interface. Deals with methods related to user operations - registering, logging in and other.

Method Summary

Modifier and Type	Method and Description
void	addAddress(AddressData addressData) Adds the address for the current user
void	editAddress(AddressData addressData) Updates the address for the current user
java.util.List<AddressData>	getAddressBook() Get the list of delivery addresses.
AddressData	getAddressForCode(java.lang.String code) Returns the address with matching code for the current user
CCPaymentInfoData	getCCPaymentInfoForCode(java.lang.String code) Returns the current user's credit card payment info given it's code
java.util.List<CCPaymentInfoData>	getCCPaymentInfos(boolean saved) Returns the current user's Credit Card Payment Infos
AddressData	getDefaultAddress() Returns the default address
java.util.List<TitleData>	getTitles() Provide all localized titles.
boolean	isAddressBookEmpty() Deprecated. since 6.5, instead check if getAddressBook() is empty directly
boolean	isAnonymousUser() Test if the current user is anonymous
boolean	isDefaultAddress(java.lang.String addressId) Test if the address id matches with the default address id
void	removeAddress(AddressData addressData) Removes the address for the current user
void	removeCCPaymentInfo(java.lang.String id) Removes credit card payment info by id
void	setDefaultAddress(AddressData addressData) Sets the default address
void	setDefaultPaymentInfo(CCPaymentInfoData paymentInfo) Sets the default Payment Info
void	syncSessionCurrency() Sets users preferred currency to the current session currency
void	syncSessionLanguage() Sets users preferred language to the current session language
void	unlinkCCPaymentInfo(java.lang.String id) Deprecated. since 6.7. Use removeCCPaymentInfo(String) instead
void	updateCCPaymentInfo(CCPaymentInfoData paymentInfo) Updates current users' payment info

Method Detail

getTitles

java.util.List<TitleData> getTitles()

Provide all localized titles.

Returns:

List of TitleData objects

isAddressBookEmpty

@Deprecated
boolean isAddressBookEmpty()

Deprecated. since 6.5, instead check if getAddressBook() is empty directly

Test if the address book is empty.

Returns:

true if the customer has no addresses

getAddressBook

java.util.List<AddressData> getAddressBook()

Get the list of delivery addresses.

Returns:

the delivery addresses

addAddress

void addAddress(AddressData addressData)

Adds the address for the current user

Parameters:

addressData - the address to add

removeAddress

void removeAddress(AddressData addressData)

Removes the address for the current user

Parameters:

addressData - the address to remove

editAddress

void editAddress(AddressData addressData)

Updates the address for the current user

Parameters:

addressData - the address to update

setDefaultAddress

void setDefaultAddress(AddressData addressData)

Sets the default address

Parameters:

addressData - the address to make default

getDefaultAddress

AddressData getDefaultAddress()

Returns the default address

Returns:

the address

getAddressForCode

AddressData getAddressForCode(java.lang.String code)

Returns the address with matching code for the current user

Parameters:

code - the address code

Returns:

the address

isDefaultAddress

boolean isDefaultAddress(java.lang.String addressId)

Test if the address id matches with the default address id

Parameters:

addressId - the address Id

Returns:

true if address id is the default address id

getCCPaymentInfos

java.util.List<CCPaymentInfoData> getCCPaymentInfos(boolean saved)

Returns the current user's Credit Card Payment Infos

Parameters:

saved - true to retrieve only saved credit card payment infos

Returns:

list of Credit Card Payment Info Data

getCCPaymentInfoForCode

CCPaymentInfoData getCCPaymentInfoForCode(java.lang.String code)

Returns the current user's credit card payment info given it's code

Parameters:

code - the code

Returns:

the Credit Card Payment Info Data

updateCCPaymentInfo

void updateCCPaymentInfo(CCPaymentInfoData paymentInfo)

Updates current users' payment info

Parameters:

paymentInfo - - new payment info data

removeCCPaymentInfo

void removeCCPaymentInfo(java.lang.String id)

Removes credit card payment info by id

Parameters:

id - the id

unlinkCCPaymentInfo

@Deprecated
void unlinkCCPaymentInfo(java.lang.String id)

Deprecated. since 6.7. Use removeCCPaymentInfo(String) instead

Unlink the credit card info from the customer by CC id

Parameters:

id - the id

setDefaultPaymentInfo

void setDefaultPaymentInfo(CCPaymentInfoData paymentInfo)

Sets the default Payment Info

Parameters:

paymentInfo - the paymentInfo to make default

syncSessionLanguage

void syncSessionLanguage()

Sets users preferred language to the current session language

syncSessionCurrency

void syncSessionCurrency()

Sets users preferred currency to the current session currency

isAnonymousUser

boolean isAnonymousUser()

Test if the current user is anonymous

Returns:

true if the current user is anonymous