com.retek.component.customer
Interface Customer

All Superinterfaces:
BusinessObject, DistributedObject
All Known Implementing Classes:
CustomerImpl

public interface Customer
extends DistributedObject

This is a interface that holds on to the customer information.


Field Summary
static java.lang.String ACTIVE
           
static java.lang.String CREDIT_CARD
           
static java.lang.String CREDIT_CARD_HISTORY
           
static java.lang.String FIRST_NAME
           
static java.lang.String ID
           
static java.lang.String LAST_NAME
           
static java.lang.String PRIMARY_BILL_TO_ADDRESS
           
static java.lang.String PRIMARY_SHIP_TO_ADDRESS
           
 
Method Summary
 void addAlternateCustomerID(java.lang.String customerID)
           
 void addAlternateHouseholdNumber(java.lang.String householdNumber)
           
 void addCreditCard(CustomerCreditCard card)
           
 void addPreference(CustomerPreference preference)
           
 void addStoredValueCardCashout(StoredValueCardCashout cashout)
           
 CustomerAddress applyActiveAddress(CustomerAddress address)
          Ensures that a CustomerAddress with the same address text as the address parameter exists in this Customer's active address list.
 CustomerEmailAddress applyActiveEmail(CustomerEmailAddress customerEmailAddress)
          Ensures that a CustomerEmail with the same email address text as the email parameter exists in this Customer's active email list.
 CustomerTelephone applyActiveTelephone(CustomerTelephone telephone)
          Ensures that a CustomerTelephone with the same number and extension as the telephone parameter exists in this Customer's active telephone list.
 AcquisitionMethod getAcquisitionMethod()
           
 java.util.List getActiveAddresses()
           
 java.util.List getActiveBillToAddresses()
           
 java.util.List getActiveCreditCards(Banner banner)
           
 java.util.List getActiveEmailAddresses()
           
 java.util.List getActiveShipToAddresses()
           
 java.util.List getActiveTelephoneNumbers()
           
 java.util.List getAllActiveCreditCards()
           
 java.util.List getAllAddresses()
           
 java.util.List getAllEmailAddresses()
           
 java.util.List getAllTelephoneNumbers()
           
 java.util.Set getAlternateCustomerIDs()
           
 java.util.Set getAlternateHouseholdNumbers()
           
 RDate getCreateDate()
           
 java.util.List getCreditCards(Banner banner)
           
 CustomerCreditPreApproval getCreditPreApproval(Banner banner)
           
 CustomerCreditPreApproval getCreditPreApproval(Banner banner, boolean searchThirdPartyForPreApproval)
           
 CustomerInactiveReason getCustomerInactiveReason()
           
 java.lang.String getDisplayCode()
           
 java.lang.String getFirstName()
           
 java.lang.String getFullName()
           
 java.lang.String getHouseholdNumber()
           
 Banner getInitialBanner()
           
 SourceCode getInitialSourceCode()
           
 RDate getLastImportDate()
          Return the last import datetime that an import request was processed for this customer.
 java.lang.String getLastImportRequestId()
          Return the last import request processed for this customer.
 java.lang.String getLastName()
           
 java.lang.String getMiddleInitial()
           
 RDate getOriginalOrderDate()
           
 CustomerPreference getPreference(Banner banner)
           
 java.util.List getPreferences()
           
 CustomerAddress getPrimaryBillToAddress()
           
 CustomerEmailAddress getPrimaryCustomerEmailAddress()
           
 CustomerTelephone getPrimaryDayTelephoneNumber()
           
 CustomerTelephone getPrimaryEveningTelephoneNumber()
           
 CustomerAddress getPrimaryShipToAddress()
           
 CustomerSalutation getSalutation()
           
 java.util.List getStoredValueCardCashouts()
           
 java.lang.String getSubAccountNumber()
           
 CustomerSuffix getSuffix()
           
 boolean isActive()
           
 boolean isModified()
           
 void merge(java.util.Set customersToMerge)
           
 void setAcquisitionMethod(AcquisitionMethod acquisitionMethod)
           
 void setActive(boolean isActive)
           
 void setAddressInactive(CustomerAddress customerAddress)
           
 void setCustomerInactiveReason(CustomerInactiveReason customerInactiveReason)
           
 void setEmailInactive(CustomerEmailAddress emailAddress, boolean inactive)
           
 void setFirstName(java.lang.String firstName)
           
 void setHouseholdNumber(java.lang.String householdNumber)
           
 void setInitialBanner(Banner banner)
           
 void setInitialSourceCode(SourceCode sourceCode)
           
 void setLastName(java.lang.String lastName)
           
 void setMiddleInitial(java.lang.String middleInitial)
           
 void setOriginalOrderDate(RDate rDate)
           
 void setPrimaryBillToAddress(CustomerAddress billToAddress)
           
 void setPrimaryCustomerEmailAddress(CustomerEmailAddress emailAddress)
           
 void setPrimaryDayTelephoneNumber(CustomerTelephone telephone)
           
 void setPrimaryEveningTelephoneNumber(CustomerTelephone telephone)
           
 void setPrimaryShipToAddress(CustomerAddress shipToAddress)
           
 void setSalutation(CustomerSalutation salutation)
           
 void setStoredValueCardCashouts(java.util.List cashouts)
           
 void setSubAccountNumber(java.lang.String subAccountNumber)
           
 void setSuffix(CustomerSuffix suffix)
           
 void setTelephoneInactive(CustomerTelephone telephone, boolean inactive)
           
 void submit(User user)
           
 
Methods inherited from interface com.retek.commons.component.DistributedObject
debugToString, discardChanges, getContext, getId, getReference, isDeleted, isDirty, isDirtyDeep, isDirtyIgnoreFields, isPersisted, refresh
 
Methods inherited from interface com.retek.commons.component.BusinessObject
getBusinessInterface
 

Field Detail

FIRST_NAME

public static final java.lang.String FIRST_NAME
See Also:
Constant Field Values

LAST_NAME

public static final java.lang.String LAST_NAME
See Also:
Constant Field Values

PRIMARY_BILL_TO_ADDRESS

public static final java.lang.String PRIMARY_BILL_TO_ADDRESS
See Also:
Constant Field Values

PRIMARY_SHIP_TO_ADDRESS

public static final java.lang.String PRIMARY_SHIP_TO_ADDRESS
See Also:
Constant Field Values

CREDIT_CARD_HISTORY

public static final java.lang.String CREDIT_CARD_HISTORY
See Also:
Constant Field Values

CREDIT_CARD

public static final java.lang.String CREDIT_CARD
See Also:
Constant Field Values

ACTIVE

public static final java.lang.String ACTIVE
See Also:
Constant Field Values

ID

public static final java.lang.String ID
See Also:
Constant Field Values
Method Detail

getDisplayCode

public java.lang.String getDisplayCode()

getSalutation

public CustomerSalutation getSalutation()
                                 throws SystemException
Throws:
SystemException

getFirstName

public java.lang.String getFirstName()
                              throws SystemException
Throws:
SystemException

getMiddleInitial

public java.lang.String getMiddleInitial()
                                  throws SystemException
Throws:
SystemException

getLastName

public java.lang.String getLastName()
                             throws SystemException
Throws:
SystemException

getFullName

public java.lang.String getFullName()
                             throws SystemException
Throws:
SystemException

getSuffix

public CustomerSuffix getSuffix()
                         throws SystemException
Throws:
SystemException

getPrimaryShipToAddress

public CustomerAddress getPrimaryShipToAddress()
                                        throws SystemException
Throws:
SystemException

getPrimaryBillToAddress

public CustomerAddress getPrimaryBillToAddress()
                                        throws SystemException
Throws:
SystemException

getActiveAddresses

public java.util.List getActiveAddresses()
                                  throws SystemException
Throws:
SystemException

getAllAddresses

public java.util.List getAllAddresses()
                               throws SystemException
Throws:
SystemException

getActiveShipToAddresses

public java.util.List getActiveShipToAddresses()
                                        throws SystemException
Throws:
SystemException

getActiveBillToAddresses

public java.util.List getActiveBillToAddresses()
                                        throws SystemException
Throws:
SystemException

getActiveTelephoneNumbers

public java.util.List getActiveTelephoneNumbers()
                                         throws SystemException
Throws:
SystemException

getAllTelephoneNumbers

public java.util.List getAllTelephoneNumbers()
                                      throws SystemException
Throws:
SystemException

getAlternateHouseholdNumbers

public java.util.Set getAlternateHouseholdNumbers()
                                           throws SystemException
Throws:
SystemException

getAlternateCustomerIDs

public java.util.Set getAlternateCustomerIDs()
                                      throws SystemException
Throws:
SystemException

getStoredValueCardCashouts

public java.util.List getStoredValueCardCashouts()
                                          throws SystemException
Throws:
SystemException

getPrimaryDayTelephoneNumber

public CustomerTelephone getPrimaryDayTelephoneNumber()
                                               throws SystemException
Throws:
SystemException

getPrimaryEveningTelephoneNumber

public CustomerTelephone getPrimaryEveningTelephoneNumber()
                                                   throws SystemException
Throws:
SystemException

getActiveEmailAddresses

public java.util.List getActiveEmailAddresses()
                                       throws SystemException
Throws:
SystemException

getAllEmailAddresses

public java.util.List getAllEmailAddresses()
                                    throws SystemException
Throws:
SystemException

getPrimaryCustomerEmailAddress

public CustomerEmailAddress getPrimaryCustomerEmailAddress()
                                                    throws SystemException
Throws:
SystemException

getAcquisitionMethod

public AcquisitionMethod getAcquisitionMethod()
                                       throws SystemException
Throws:
SystemException

getInitialBanner

public Banner getInitialBanner()
                        throws SystemException
Throws:
SystemException

getInitialSourceCode

public SourceCode getInitialSourceCode()
                                throws SystemException
Throws:
SystemException

getPreferences

public java.util.List getPreferences()
                              throws SystemException
Throws:
SystemException

getPreference

public CustomerPreference getPreference(Banner banner)
                                 throws SystemException
Throws:
SystemException

getCreditCards

public java.util.List getCreditCards(Banner banner)
                              throws SystemException,
                                     BusinessException
Throws:
SystemException
BusinessException

getActiveCreditCards

public java.util.List getActiveCreditCards(Banner banner)
                                    throws SystemException,
                                           BusinessException
Throws:
SystemException
BusinessException

getAllActiveCreditCards

public java.util.List getAllActiveCreditCards()
                                       throws SystemException
Throws:
SystemException

getOriginalOrderDate

public RDate getOriginalOrderDate()
                           throws SystemException
Throws:
SystemException

getCreateDate

public RDate getCreateDate()
                    throws SystemException
Throws:
SystemException

isModified

public boolean isModified()
                   throws SystemException
Throws:
SystemException

getHouseholdNumber

public java.lang.String getHouseholdNumber()
                                    throws SystemException
Throws:
SystemException

getSubAccountNumber

public java.lang.String getSubAccountNumber()
                                     throws SystemException
Throws:
SystemException

isActive

public boolean isActive()
                 throws SystemException
Throws:
SystemException

getCustomerInactiveReason

public CustomerInactiveReason getCustomerInactiveReason()
                                                 throws SystemException
Throws:
SystemException

getCreditPreApproval

public CustomerCreditPreApproval getCreditPreApproval(Banner banner,
                                                      boolean searchThirdPartyForPreApproval)
                                               throws SystemException,
                                                      BusinessException
Throws:
SystemException
BusinessException

getCreditPreApproval

public CustomerCreditPreApproval getCreditPreApproval(Banner banner)
                                               throws SystemException,
                                                      BusinessException
Throws:
SystemException
BusinessException

getLastImportDate

public RDate getLastImportDate()
                        throws SystemException
Return the last import datetime that an import request was processed for this customer.

Returns:
RDate last import datetime
Throws:
SystemException

getLastImportRequestId

public java.lang.String getLastImportRequestId()
                                        throws SystemException
Return the last import request processed for this customer.

Returns:
String last import request identifier
Throws:
SystemException

setActive

public void setActive(boolean isActive)
               throws SystemException
Throws:
SystemException

setCustomerInactiveReason

public void setCustomerInactiveReason(CustomerInactiveReason customerInactiveReason)
                               throws SystemException
Throws:
SystemException

setSalutation

public void setSalutation(CustomerSalutation salutation)
                   throws SystemException
Throws:
SystemException

setFirstName

public void setFirstName(java.lang.String firstName)
                  throws SystemException
Throws:
SystemException

setMiddleInitial

public void setMiddleInitial(java.lang.String middleInitial)
                      throws SystemException
Throws:
SystemException

setLastName

public void setLastName(java.lang.String lastName)
                 throws SystemException
Throws:
SystemException

setSuffix

public void setSuffix(CustomerSuffix suffix)
               throws SystemException
Throws:
SystemException

setPrimaryShipToAddress

public void setPrimaryShipToAddress(CustomerAddress shipToAddress)
                             throws SystemException,
                                    BusinessException
Throws:
SystemException
BusinessException

setPrimaryBillToAddress

public void setPrimaryBillToAddress(CustomerAddress billToAddress)
                             throws SystemException,
                                    BusinessException
Throws:
SystemException
BusinessException

setAddressInactive

public void setAddressInactive(CustomerAddress customerAddress)
                        throws SystemException,
                               BusinessException
Throws:
SystemException
BusinessException

setPrimaryCustomerEmailAddress

public void setPrimaryCustomerEmailAddress(CustomerEmailAddress emailAddress)
                                    throws SystemException
Throws:
SystemException

setEmailInactive

public void setEmailInactive(CustomerEmailAddress emailAddress,
                             boolean inactive)
                      throws SystemException
Throws:
SystemException

setPrimaryDayTelephoneNumber

public void setPrimaryDayTelephoneNumber(CustomerTelephone telephone)
                                  throws SystemException
Throws:
SystemException

setPrimaryEveningTelephoneNumber

public void setPrimaryEveningTelephoneNumber(CustomerTelephone telephone)
                                      throws SystemException
Throws:
SystemException

setTelephoneInactive

public void setTelephoneInactive(CustomerTelephone telephone,
                                 boolean inactive)
                          throws SystemException,
                                 BusinessException
Throws:
SystemException
BusinessException

setInitialBanner

public void setInitialBanner(Banner banner)
                      throws SystemException
Throws:
SystemException

setInitialSourceCode

public void setInitialSourceCode(SourceCode sourceCode)
                          throws SystemException
Throws:
SystemException

setAcquisitionMethod

public void setAcquisitionMethod(AcquisitionMethod acquisitionMethod)
                          throws SystemException
Throws:
SystemException

setOriginalOrderDate

public void setOriginalOrderDate(RDate rDate)
                          throws SystemException
Throws:
SystemException

setHouseholdNumber

public void setHouseholdNumber(java.lang.String householdNumber)
                        throws SystemException
Throws:
SystemException

setSubAccountNumber

public void setSubAccountNumber(java.lang.String subAccountNumber)
                         throws SystemException
Throws:
SystemException

addAlternateHouseholdNumber

public void addAlternateHouseholdNumber(java.lang.String householdNumber)
                                 throws SystemException
Throws:
SystemException

addAlternateCustomerID

public void addAlternateCustomerID(java.lang.String customerID)
                            throws SystemException
Throws:
SystemException

addPreference

public void addPreference(CustomerPreference preference)
                   throws SystemException
Throws:
SystemException

setStoredValueCardCashouts

public void setStoredValueCardCashouts(java.util.List cashouts)
                                throws SystemException
Throws:
SystemException

addStoredValueCardCashout

public void addStoredValueCardCashout(StoredValueCardCashout cashout)
                               throws SystemException
Throws:
SystemException

applyActiveAddress

public CustomerAddress applyActiveAddress(CustomerAddress address)
                                   throws BusinessException,
                                          SystemException
Ensures that a CustomerAddress with the same address text as the address parameter exists in this Customer's active address list.

The correct usage is: myAddr = applyActiveAddress(myAddr);

If you forget to assign the return to your reference, then your reference (e.g. myAddr) may not refer to an addr in the customer's list.

Returns:
a reference to a CustomerAddress in the active address list. If the address parameter represents a new address, it will have been added to the list and returned. On the other hand, if an existing address in the active address list matches the parameter's address text (i.e. has the same line1, line2, etec.), then the existing address object is returned.
Throws:
BusinessException
SystemException

applyActiveEmail

public CustomerEmailAddress applyActiveEmail(CustomerEmailAddress customerEmailAddress)
                                      throws InvalidCustomerEmailException,
                                             SystemException
Ensures that a CustomerEmail with the same email address text as the email parameter exists in this Customer's active email list.

The correct usage is: myEmail = applyActiveEmail(myEmail);

If you forget to assign the return to your reference, then your reference (e.g. myEmail) may not refer to an email in the customer's list.

Returns:
a reference to a CustomerEmail in the active email list. If the email parameter represents a new email, it will have been added to the list and returned. On the other hand, if an existing email in the active email list matches the parameter's email (i.e. has the same email string, but perhaps a different id), then the existing email object is returned.
Throws:
InvalidCustomerEmailException
SystemException

applyActiveTelephone

public CustomerTelephone applyActiveTelephone(CustomerTelephone telephone)
                                       throws InvalidCustomerTelephoneException,
                                              SystemException
Ensures that a CustomerTelephone with the same number and extension as the telephone parameter exists in this Customer's active telephone list.

The correct usage is: myTelephone = applyActiveTelephone(myTelephone);

If you forget to assign the return to your reference, then your reference (e.g. myTelephone) may not refer to a telephone in the customer's list.

Returns:
a reference to a CustomerTelephone in the active telephone list. If the telephone parameter represents a new telephone, it will have been added to the list and returned. On the other hand, if an existing telephone in the active telephone list matches the parameter's telephone (i.e. has the same number and extension, but perhaps a different id), then the existing telephone object is returned.
Throws:
InvalidCustomerTelephoneException
SystemException

addCreditCard

public void addCreditCard(CustomerCreditCard card)
                   throws SystemException,
                          BusinessException
Throws:
SystemException
BusinessException

submit

public void submit(User user)
            throws BusinessException,
                   SystemException
Throws:
BusinessException
SystemException

merge

public void merge(java.util.Set customersToMerge)
           throws BusinessException,
                  SystemException
Throws:
BusinessException
SystemException


Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28