com.elasticpath.domain.customer
Interface CustomerSession

All Superinterfaces:
Entity, EpDomain, Persistence, java.io.Serializable
All Known Implementing Classes:
CustomerSessionImpl

public interface CustomerSession
extends Entity

A customer session keeps track of information about customers who may not be logged in (using cookies).


Method Summary
 CustomerSession getClone()
          Creates a copy of the CustomerSession.
 java.util.Date getCreationDate()
          Get the date when the customer session was created.
 java.util.Currency getCurrency()
          Get the currency of the customer corresponding to the shopping cart.
 Customer getCustomer()
          Get the customer corresponding to this session.
 java.lang.String getEmail()
          Get the customer email address corresponding to the session.
 java.lang.String getIpAddress()
          Get the ipAddress of the user from the shopping cart.
 java.util.Date getLastAccessedDate()
          Get the date when the customer session was last accessed.
 java.util.Locale getLocale()
          Get the locale of the customer corresponding to the shopping cart.
 boolean isSignedIn()
          Returns true if the customer is singed in.
 void setCreationDate(java.util.Date creationDate)
          Set the creation date.
 void setCurrency(java.util.Currency currency)
          Set the currency of the customer corresponding to the shopping cart.
 void setCustomer(Customer customer)
          Set the customer corresponding to this session.
 void setEmail(java.lang.String email)
          Set the customer email address corresponding to the session.
 void setIpAddress(java.lang.String ipAddress)
          Set the users ip Address into the shopping cart.
 void setLastAccessedDate(java.util.Date lastAccessedDate)
          Set the last access date.
 void setLocale(java.util.Locale locale)
          Set the locale of the customer corresponding to the shopping cart.
 void setSignedIn(boolean signedIn)
          Set to true if the customer is signed in.
 
Methods inherited from interface com.elasticpath.domain.Entity
getGuid, setGuid
 
Methods inherited from interface com.elasticpath.domain.Persistence
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getClone

CustomerSession getClone()
Creates a copy of the CustomerSession.

Returns:
the copy

getCreationDate

java.util.Date getCreationDate()
Get the date when the customer session was created.

Returns:
the creation date

getCurrency

java.util.Currency getCurrency()
Get the currency of the customer corresponding to the shopping cart.

Returns:
the Currency

getCustomer

Customer getCustomer()
Get the customer corresponding to this session. Returns null if the customer is unknown.

Returns:
the customer Uid (or null if unknown)

getEmail

java.lang.String getEmail()
Get the customer email address corresponding to the session. Returns null if unknown.

Returns:
the customer's email address or null if unknown

getIpAddress

java.lang.String getIpAddress()
Get the ipAddress of the user from the shopping cart.

Returns:
the ipAddress

getLastAccessedDate

java.util.Date getLastAccessedDate()
Get the date when the customer session was last accessed.

Returns:
the last accessed date.

getLocale

java.util.Locale getLocale()
Get the locale of the customer corresponding to the shopping cart.

Returns:
the Locale

isSignedIn

boolean isSignedIn()
Returns true if the customer is singed in.

Returns:
true if the customer is signed in.

setCreationDate

void setCreationDate(java.util.Date creationDate)
Set the creation date.

Parameters:
creationDate - the creation date.

setCurrency

void setCurrency(java.util.Currency currency)
Set the currency of the customer corresponding to the shopping cart.

Parameters:
currency - the Currency

setCustomer

void setCustomer(Customer customer)
Set the customer corresponding to this session.

Parameters:
customer - the Uid of the corresponding customer.

setEmail

void setEmail(java.lang.String email)
Set the customer email address corresponding to the session.

Parameters:
email - the email address.

setIpAddress

void setIpAddress(java.lang.String ipAddress)
Set the users ip Address into the shopping cart.

Parameters:
ipAddress - the ipAddress of the user.

setLastAccessedDate

void setLastAccessedDate(java.util.Date lastAccessedDate)
Set the last access date.

Parameters:
lastAccessedDate - the last access date.

setLocale

void setLocale(java.util.Locale locale)
Set the locale of the customer corresponding to the shopping cart.

Parameters:
locale - the Locale

setSignedIn

void setSignedIn(boolean signedIn)
Set to true if the customer is signed in.

Parameters:
signedIn - set to true if the customer is signed in.