com.elasticpath.domain.customer
Interface CustomerCreditCard

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

public interface CustomerCreditCard
extends Entity

A CustomerCreditCard is a credit card stored by a store-front customer.


Method Summary
 void encrypt()
          Encrypts the credit card number.
 CustomerAddress getBillingAddress()
           
 java.lang.String getCardHolderName()
           
 java.lang.String getCardNumber()
           
 java.lang.String getCardType()
           
 java.lang.String getExpiryMonth()
           
 java.lang.String getExpiryYear()
           
 int getIssueNumber()
           
 java.lang.String getMaskedCardNumber()
          Decrypts and returns the masked credit card number: ************5381.
 java.lang.String getSecurityCode()
          Get the 3 or 4 digit security code from the back of the card.
 java.lang.String getStartMonth()
           
 java.lang.String getStartYear()
           
 java.lang.String getUnencryptedCardNumber()
          Decrypts and returns the full credit card number.
 boolean isDefaultCard()
           
 void setBillingAddress(CustomerAddress billingAddress)
           
 void setCardHolderName(java.lang.String cardHolderName)
           
 void setCardNumber(java.lang.String cardNumber)
           
 void setCardType(java.lang.String cardType)
           
 void setDefaultCard(boolean defaultCard)
           
 void setExpiryMonth(java.lang.String expiryMonth)
           
 void setExpiryYear(java.lang.String expiryYear)
           
 void setIssueNumber(int issueNumber)
           
 void setSecurityCode(java.lang.String securityCode)
          Set the 3 or 4 digit security code from the back of the card.
 void setStartMonth(java.lang.String startMonth)
           
 void setStartYear(java.lang.String startYear)
           
 
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

encrypt

void encrypt()
Encrypts the credit card number.


getBillingAddress

CustomerAddress getBillingAddress()
Returns:
the billingAddress

getCardHolderName

java.lang.String getCardHolderName()
Returns:
the cardHolderName

getCardNumber

java.lang.String getCardNumber()
Returns:
the cardNumber

getCardType

java.lang.String getCardType()
Returns:
the cardType

getExpiryMonth

java.lang.String getExpiryMonth()
Returns:
the expiryMonth

getExpiryYear

java.lang.String getExpiryYear()
Returns:
the expiryYear

getIssueNumber

int getIssueNumber()
Returns:
the issueNumber

getMaskedCardNumber

java.lang.String getMaskedCardNumber()
Decrypts and returns the masked credit card number: ************5381. Useful for displaying in receipts, GUI, order history, etc.

Returns:
the masked credit card number

getSecurityCode

java.lang.String getSecurityCode()
Get the 3 or 4 digit security code from the back of the card. This value cannot be persisted and will not be available unless the user has specified it.

Returns:
the security code

getStartMonth

java.lang.String getStartMonth()
Returns:
the startMonth

getStartYear

java.lang.String getStartYear()
Returns:
the startYear

getUnencryptedCardNumber

java.lang.String getUnencryptedCardNumber()
Decrypts and returns the full credit card number. Access to this method should be restricted!

Returns:
the decrypted credit card number

isDefaultCard

boolean isDefaultCard()
Returns:
the defaultCard

setBillingAddress

void setBillingAddress(CustomerAddress billingAddress)
Parameters:
billingAddress - the billingAddress to set

setCardHolderName

void setCardHolderName(java.lang.String cardHolderName)
Parameters:
cardHolderName - the cardHolderName to set

setCardNumber

void setCardNumber(java.lang.String cardNumber)
Parameters:
cardNumber - the cardNumber to set

setCardType

void setCardType(java.lang.String cardType)
Parameters:
cardType - the cardType to set

setDefaultCard

void setDefaultCard(boolean defaultCard)
Parameters:
defaultCard - the defaultCard to set

setExpiryMonth

void setExpiryMonth(java.lang.String expiryMonth)
Parameters:
expiryMonth - the expiryMonth to set

setExpiryYear

void setExpiryYear(java.lang.String expiryYear)
Parameters:
expiryYear - the expiryYear to set

setIssueNumber

void setIssueNumber(int issueNumber)
Parameters:
issueNumber - the issueNumber to set

setSecurityCode

void setSecurityCode(java.lang.String securityCode)
Set the 3 or 4 digit security code from the back of the card. This value IS NOT persistent.

Parameters:
securityCode - the security code

setStartMonth

void setStartMonth(java.lang.String startMonth)
Parameters:
startMonth - the startMonth to set

setStartYear

void setStartYear(java.lang.String startYear)
Parameters:
startYear - the startYear to set