com.elasticpath.xpf.connectivity.entity

Class XPFCustomer

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFCustomer

public class XPFCustomer
extends XPFEntity

Customer Extension Point entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFCustomer.XPFCustomerBuilder<C extends XPFCustomer,B extends XPFCustomer.XPFCustomerBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFCustomer(@NonNull String guid, @NonNull String sharedId, @NonNull Date createdDate, String email, @NonNull XPFCustomerStatusEnum status, @NonNull XPFCustomerTypeEnum type, @NonNull Map<Locale,Map<String,XPFAttributeValue>> attributeValues, @NonNull Set<String> segments, @NonNull boolean firstTimeBuyer)
protected	XPFCustomer(XPFCustomer.XPFCustomerBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFCustomer.XPFCustomerBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAccountName() Returns the account name of the customer.
Optional<XPFAttributeValue>	getAttributeValueByKey(String key) Returns the non-localized attribute value with the passed key (case-insensitive match).
Optional<XPFAttributeValue>	getAttributeValueByKey(String key, Locale locale) Returns the attribute value with the passed key (case-insensitive match) and locale.
@NonNull Map<Locale,Map<String,XPFAttributeValue>>	getAttributeValues() The customer's attribute value maps of maps keyed by Locale and then by attribute key.
@NonNull Date	getCreatedDate() The date the customer was created.
String	getEmail() The user's email address.
String	getFirstName() Returns the first name of the customer.
@NonNull String	getGuid() The user's guid.
String	getLastName() Returns the last name of the customer.
String	getPreferredCurrency() Returns the preferred currency of the customer.
String	getPreferredLocale() Returns the preferred locale of the customer.
@NonNull Set<String>	getSegments() The segment codes that the user is associated to.
@NonNull String	getSharedId() A unique identifier for the customer that can be shared with external services.
@NonNull XPFCustomerStatusEnum	getStatus() The user's status.
@NonNull XPFCustomerTypeEnum	getType() The customer type (i.e.
int	hashCode()
@NonNull boolean	isFirstTimeBuyer() Is the customer a first time buyer.
void	setAccountName(String accountName) Sets the account name of the customer.
void	setFirstName(String firstName) Sets the first name of the customer.
void	setLastName(String lastName) Sets the last name of the customer.
void	setPreferredCurrency(String preferredCurrency) Sets the preferred currency of the customer.
void	setPreferredLocale(String preferredLocale) Sets the preferred locale of the customer.
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFCustomer

protected XPFCustomer(XPFCustomer.XPFCustomerBuilder<?,?> b)

XPFCustomer

public XPFCustomer(@NonNull
                   @NonNull String guid,
                   @NonNull
                   @NonNull String sharedId,
                   @NonNull
                   @NonNull Date createdDate,
                   String email,
                   @NonNull
                   @NonNull XPFCustomerStatusEnum status,
                   @NonNull
                   @NonNull XPFCustomerTypeEnum type,
                   @NonNull
                   @NonNull Map<Locale,Map<String,XPFAttributeValue>> attributeValues,
                   @NonNull
                   @NonNull Set<String> segments,
                   @NonNull
                   @NonNull boolean firstTimeBuyer)

Method Detail

getAttributeValueByKey

public Optional<XPFAttributeValue> getAttributeValueByKey(String key,
                                                          Locale locale)

Returns the attribute value with the passed key (case-insensitive match) and locale.

Parameters:

key - the attribute key

locale - the attribute value locale

Returns:

attribute value

getAttributeValueByKey

public Optional<XPFAttributeValue> getAttributeValueByKey(String key)

Returns the non-localized attribute value with the passed key (case-insensitive match).

Parameters:

key - the attribute key

Returns:

attribute value

getFirstName

public String getFirstName()

Returns the first name of the customer.

Returns:

the first name as a String, or null if not available

setFirstName

public void setFirstName(String firstName)

Sets the first name of the customer.

Parameters:

firstName - the first name to set

getLastName

public String getLastName()

Returns the last name of the customer.

Returns:

the last name as a String, or null if not available

setLastName

public void setLastName(String lastName)

Sets the last name of the customer.

Parameters:

lastName - the last name to set

getAccountName

public String getAccountName()

Returns the account name of the customer.

Returns:

the account name as a String, or null if not available

setAccountName

public void setAccountName(String accountName)

Sets the account name of the customer.

Parameters:

accountName - the account name to set

getPreferredLocale

public String getPreferredLocale()

Returns the preferred locale of the customer.

Returns:

the preferred locale as a String, or null if not available

setPreferredLocale

public void setPreferredLocale(String preferredLocale)

Sets the preferred locale of the customer.

Parameters:

preferredLocale - the preferred locale to set

getPreferredCurrency

public String getPreferredCurrency()

Returns the preferred currency of the customer.

Returns:

the preferred currency as a String, or null if not available

setPreferredCurrency

public void setPreferredCurrency(String preferredCurrency)

Sets the preferred currency of the customer.

Parameters:

preferredCurrency - the preferred currency to set

builder

public static XPFCustomer.XPFCustomerBuilder<?,?> builder()

getGuid

@NonNull
public @NonNull String getGuid()

The user's guid.

getSharedId

@NonNull
public @NonNull String getSharedId()

A unique identifier for the customer that can be shared with external services.

getCreatedDate

@NonNull
public @NonNull Date getCreatedDate()

The date the customer was created.

getEmail

public String getEmail()

The user's email address.

getStatus

@NonNull
public @NonNull XPFCustomerStatusEnum getStatus()

The user's status.

getType

@NonNull
public @NonNull XPFCustomerTypeEnum getType()

The customer type (i.e. SINGLE_SESSION_USER, REGISTERED_USER, or ACCOUNT).

getAttributeValues

@NonNull
public @NonNull Map<Locale,Map<String,XPFAttributeValue>> getAttributeValues()

The customer's attribute value maps of maps keyed by Locale and then by attribute key.

getSegments

@NonNull
public @NonNull Set<String> getSegments()

The segment codes that the user is associated to.

isFirstTimeBuyer

@NonNull
public @NonNull boolean isFirstTimeBuyer()

Is the customer a first time buyer.

toString

public String toString()

Overrides:

toString in class XPFEntity

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity