com.retek.component.customer
Interface CustomerManager

All Superinterfaces:
DistributedObjectManager
All Known Implementing Classes:
CustomerManagerImpl

public interface CustomerManager
extends DistributedObjectManager

Manager class that handles customer related operations like read, find, create, etc.


Method Summary
 CareCardActivityRequest buildCareCardActivityRequest()
          Builds a new instance of CareCardActivityRequest with activityRequestType set to ActivityRequestType.CARE_CARD
 CatalogRequest buildCatalogRequestInstance()
          Builds a new instance of CatalogRequest and initializes the following values origin = CatalogRequestOrigin.PHONE requestType = CatalogRequestType.UNPAID_INQUIRY createDate = current date
 CatalogType buildCatalogTypeInstance(Banner banner, java.lang.String desc, int estimatedDeliveryDays)
          Builds a new instance of CatalogType, initializes description to desc param value, and estimatedDeliveryDays to estimatedDeliveryDays param value.
 CustomerAddress buildCustomerAddressInstance()
          Builds a new instance of CustomerAddress with country initialized to default country.
 CustomerAddress buildCustomerAddressInstance(CustomerAddress copyFromAddress)
          Builds a new instance of CustomerAddress with all attribute values initialized to the current values on copyFromAddress.
 CustomerCreditCard buildCustomerCreditCardInstance(Banner banner)
          Builds a new CustomerCreditCard with banner initialized to banner parameter, and a new CreditCard.
 CustomerCreditPreApproval buildCustomerCreditPreApprovalInstance()
          Builds a new instance of CustomerCreditPreApproval
 CustomerEmailAddress buildCustomerEmailAddressInstance()
          Builds a new instance of CustomerEmailAddress
 Customer buildCustomerInstance()
          Builds a new instance of Customer and initializes the following values acquisitionMethod = AcquisitionMethod.BUYER
 CustomerPLCCCreditApplication buildCustomerPLCCCreditApplicationInstance(Customer customer)
          Builds a customer credit application for a customer
 CustomerPreference buildCustomerPreferenceInstance(Banner banner)
          Builds a new instance of CustomerPreference with banner initialized to banner parameter.
 CustomerTelephone buildCustomerTelephoneInstance()
          Builds a new instance of CustomerTelephone
 CustomerMergeRequest buildExportCustomerMergeRequestInstance(Customer activeCustomer, User user)
          Builds a new instance of CustomerMergeRequest.
 ForwardAddressActivityRequest buildForwardAddressActivityRequest()
          Builds a new instance of ForwardAddressActivityRequest with activityRequestType set to ActivityRequestType.FORWARD_ADDRESS
 GeneralActivityRequest buildGeneralActivityRequest()
          Builds a new instance of GeneralActivityRequest with activityRequestType set to ActivityRequestType.GENERAL
 CustomerMergeRequest buildImportCustomerMergeRequestInstance(java.lang.String externalRequestId, DistributedReference activeCustomerRef, User user)
          Builds a new instance of CustomerMergeRequest.
 ItemInstructionsActivityRequest buildItemInstructionsActivityRequest()
          Builds a new instance of ItemActivityRequest with activityRequestType set to ActivityRequestType.ITEMINSTRUCTIONS
 LabelActivityRequest buildLabelActivityRequest()
          Builds a new instance of LabelActivityRequest with activityRequestType set to ActivityRequestType.LABEL
 PartialActivityRequest buildPartialActivityRequest()
          Builds a new instance of PartialActivityRequest with activityRequestType set to ActivityRequestType.PARTIAL
 RefundOrGiftCertificateActivityRequest buildRefundOrGiftCertificateActivityRequest()
          Builds a new instance of RefundOrGiftCertificateActivityRequest with activityRequestType set to ActivityRequestType.REFUND
 ReturnActivityRequest buildReturnActivityRequest()
          Builds a new instance of ReturnActivityRequest with activityRequestType set to ActivityRequestType.RETURN
 SpecialOrderActivityRequest buildSpecialOrderActivityRequest()
          Builds a new instance of SpecialOrderActivityRequest with activityRequestType set to ActivityRequestType.SPECIAL_ORDER
 StoredValueCardCashout buildStoredValueCardCashoutInstance()
          Builds a new instance of a StoredValueCardCashout
 WismoActivityRequest buildWismoActivityRequest()
          Builds a new instance of WismoActivityRequest with activityRequestType set to ActivityRequestType.WISMO
 StoredValueCardCashoutResponse cashOutStoredValueCardForCustomer(java.lang.String number, java.lang.String pin, Customer customer, User user)
           
 java.util.Set find(CatalogTypeSearchCriteria criteria)
          Finds all CatalogTypes based on search criteria
 java.util.List find(CustomerFindCriteria findCriteria)
           
 ActivityRequest findActivityRequestById(java.lang.String id)
           
 java.util.Set findActivityRequests(Customer customer)
           
 java.util.Set findAllActivityRequestTypes()
           
 java.util.Set findAllCatalogTypes()
          Finds all active CatalogTypes
 java.util.Set findAllCustomerInactiveReasons()
           
 java.util.List findAllSalutations()
           
 java.util.Set findAllStoredValueCardCashoutsForSalesAuditExport()
          Find all stored value card cashouts marked as 'R'eady for sales audit export.
 java.util.List findAllSuffixes()
           
 java.util.Set findCustomerChangeReasons(CustomerAddress custAddress)
           
 java.util.Set findCustomerCreditPreApproval(CustomerCreditPreApprovalSearchCriteria findCriteria)
           
 java.util.Set findCustomerMergeRequestReferences(CustomerMergeRequestSearchCriteria criteria)
          Finds existing CustomerMergeRequest references based on search critiera.
 java.util.List findCustomerReferences(CustomerExportSearchCriteria findCriteria)
           
 java.util.List findCustomerReferences(CustomerFindCriteria findCriteria)
           
 java.util.Set findMatchingCustomers(CustomerMatchCriteria criteria)
          If MatchCodeFunctionality is active, finds all customers that match the criteria param value according to the current MatchRules.
 java.util.Set findOpenActivityRequests()
          Finds all activity requests of the following types that have not yet been closed: CareCardActivityRequest GeneralActivityRequest RefundOrGiftCertificateActivityRequest SpecialOrderActivityRequest
 CustomerSuffix findSuffix(java.lang.String suffixCode)
           
 java.util.Set findUnexportedCatalogRequestReferences()
          Finds all existing CatalogRequest references that have not yet been exported.
 CustomerInactiveReason getMultipleCustomerRecordsInactiveReason()
           
 void mergeCustomers(java.lang.String activeCustomerId, java.util.Set mergeCustomerIds)
          Merges information from the set of mergeCustomers into the activeCustomer
 void processCustomerMergeRequest(CustomerMergeRequest request)
          Process a customer merge request.
 Customer read(DistributedReference ref)
           
 ActivityRequest readActivityRequest(DistributedReference ref)
           
 CustomerAddress readAddress(DistributedReference ref)
           
 CatalogRequest readCatalogRequest(DistributedReference reference)
           
 java.util.Set readCatalogRequests(java.util.Set refs)
           
 CatalogType readCatalogType(DistributedReference ref)
           
 java.util.Set readCustomerMergeRequests(java.util.Set refs)
           
 java.util.List readCustomers(java.util.Collection refs)
           
 CustomerEmailAddress readEmailAddress(DistributedReference ref)
           
 ActivityRequestType readGeneralActivityRequestType()
           
 CustomerSalutation readSalutation(DistributedReference ref)
           
 CustomerSuffix readSuffix(DistributedReference ref)
           
 CustomerTelephone readTelephone(DistributedReference ref)
           
 void updateCatalogRequestsForSuccessfulExport(java.util.Set requestRefs)
          Update catalog request for successful export.
 void updateCustomerMergeRequestsForSuccessfulExport(java.util.Set requestRefs)
          Update customer merge requests for successful export.
 
Methods inherited from interface com.retek.commons.component.DistributedObjectManager
getContext
 

Method Detail

read

public Customer read(DistributedReference ref)
              throws SystemException
Throws:
SystemException

readCustomers

public java.util.List readCustomers(java.util.Collection refs)
                             throws SystemException
Throws:
SystemException

readActivityRequest

public ActivityRequest readActivityRequest(DistributedReference ref)
                                    throws SystemException
Throws:
SystemException

readCatalogRequest

public CatalogRequest readCatalogRequest(DistributedReference reference)
                                  throws SystemException
Throws:
SystemException

readCatalogRequests

public java.util.Set readCatalogRequests(java.util.Set refs)
                                  throws SystemException
Throws:
SystemException

readCatalogType

public CatalogType readCatalogType(DistributedReference ref)
                            throws SystemException
Throws:
SystemException

readAddress

public CustomerAddress readAddress(DistributedReference ref)
                            throws SystemException
Throws:
SystemException

readTelephone

public CustomerTelephone readTelephone(DistributedReference ref)
                                throws SystemException
Throws:
SystemException

readEmailAddress

public CustomerEmailAddress readEmailAddress(DistributedReference ref)
                                      throws SystemException
Throws:
SystemException

readSalutation

public CustomerSalutation readSalutation(DistributedReference ref)
                                  throws SystemException
Throws:
SystemException

readSuffix

public CustomerSuffix readSuffix(DistributedReference ref)
                          throws SystemException
Throws:
SystemException

readCustomerMergeRequests

public java.util.Set readCustomerMergeRequests(java.util.Set refs)
                                        throws SystemException
Throws:
SystemException

find

public java.util.List find(CustomerFindCriteria findCriteria)
                    throws InvalidSearchCriteriaException,
                           SystemException
Throws:
InvalidSearchCriteriaException
SystemException

findCustomerReferences

public java.util.List findCustomerReferences(CustomerFindCriteria findCriteria)
                                      throws SystemException
Throws:
SystemException

findCustomerReferences

public java.util.List findCustomerReferences(CustomerExportSearchCriteria findCriteria)
                                      throws SystemException
Throws:
SystemException

findActivityRequests

public java.util.Set findActivityRequests(Customer customer)
                                   throws SystemException,
                                          BusinessException
Throws:
SystemException
BusinessException

findAllSalutations

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

findAllSuffixes

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

findSuffix

public CustomerSuffix findSuffix(java.lang.String suffixCode)
                          throws SystemException
Throws:
SystemException

findCustomerChangeReasons

public java.util.Set findCustomerChangeReasons(CustomerAddress custAddress)
                                        throws SystemException
Throws:
SystemException

findActivityRequestById

public ActivityRequest findActivityRequestById(java.lang.String id)
                                        throws SystemException
Throws:
SystemException

findCustomerCreditPreApproval

public java.util.Set findCustomerCreditPreApproval(CustomerCreditPreApprovalSearchCriteria findCriteria)
                                            throws SystemException
Throws:
SystemException

findAllCustomerInactiveReasons

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

getMultipleCustomerRecordsInactiveReason

public CustomerInactiveReason getMultipleCustomerRecordsInactiveReason()
                                                                throws SystemException
Throws:
SystemException

buildStoredValueCardCashoutInstance

public StoredValueCardCashout buildStoredValueCardCashoutInstance()
                                                           throws SystemException,
                                                                  BusinessException
Builds a new instance of a StoredValueCardCashout

Returns:
StoredValueCardCashout - new StoredValueCardCashout instance
Throws:
SystemException
BusinessException

buildCustomerInstance

public Customer buildCustomerInstance()
                               throws SystemException
Builds a new instance of Customer and initializes the following values acquisitionMethod = AcquisitionMethod.BUYER

Returns:
Customer - new Customer instance
Throws:
SystemException

buildCustomerPreferenceInstance

public CustomerPreference buildCustomerPreferenceInstance(Banner banner)
                                                   throws SystemException
Builds a new instance of CustomerPreference with banner initialized to banner parameter.

Returns:
CustomerPreference - new CustomerPreference instance
Throws:
SystemException

buildCustomerAddressInstance

public CustomerAddress buildCustomerAddressInstance()
                                             throws SystemException
Builds a new instance of CustomerAddress with country initialized to default country.

Returns:
CustomerAddress - new CustomerAddress instance
Throws:
SystemException

buildCustomerAddressInstance

public CustomerAddress buildCustomerAddressInstance(CustomerAddress copyFromAddress)
                                             throws SystemException,
                                                    BusinessException
Builds a new instance of CustomerAddress with all attribute values initialized to the current values on copyFromAddress.

Returns:
CustomerAddress - new CustomerAddress instance
Throws:
SystemException
BusinessException

buildCustomerTelephoneInstance

public CustomerTelephone buildCustomerTelephoneInstance()
                                                 throws SystemException
Builds a new instance of CustomerTelephone

Returns:
CustomerTelephone new CustomerTelephone instance with no initial values.
Throws:
SystemException

buildCustomerEmailAddressInstance

public CustomerEmailAddress buildCustomerEmailAddressInstance()
                                                       throws SystemException
Builds a new instance of CustomerEmailAddress

Returns:
CustomerTelephone new CustomerEmailAddress instance with no initial values.
Throws:
SystemException

buildCustomerCreditPreApprovalInstance

public CustomerCreditPreApproval buildCustomerCreditPreApprovalInstance()
                                                                 throws SystemException
Builds a new instance of CustomerCreditPreApproval

Returns:
CustomerCreditPreApproval new CustomerCreditPreApproval instance with no initial values.
Throws:
SystemException

buildCustomerCreditCardInstance

public CustomerCreditCard buildCustomerCreditCardInstance(Banner banner)
                                                   throws SystemException,
                                                          BusinessException
Builds a new CustomerCreditCard with banner initialized to banner parameter, and a new CreditCard.

Returns:
CustomerCreditCard - new CustomerCreditCard instance
Throws:
SystemException
BusinessException

buildCatalogTypeInstance

public CatalogType buildCatalogTypeInstance(Banner banner,
                                            java.lang.String desc,
                                            int estimatedDeliveryDays)
                                     throws SystemException
Builds a new instance of CatalogType, initializes description to desc param value, and estimatedDeliveryDays to estimatedDeliveryDays param value.

Parameters:
desc - - initial value for new CatalogType description.
estimatedDeliveryDays - - initial value for new CatalogType estimatedDeliveryDays.
Returns:
CatalogType - new CatalogType instance
Throws:
SystemException

buildCatalogRequestInstance

public CatalogRequest buildCatalogRequestInstance()
                                           throws SystemException
Builds a new instance of CatalogRequest and initializes the following values origin = CatalogRequestOrigin.PHONE requestType = CatalogRequestType.UNPAID_INQUIRY createDate = current date

Returns:
CatalogRequest - new CatalogRequest instance
Throws:
SystemException

findUnexportedCatalogRequestReferences

public java.util.Set findUnexportedCatalogRequestReferences()
                                                     throws SystemException
Finds all existing CatalogRequest references that have not yet been exported.

Returns:
Set - resulting set of Catalog Request references
Throws:
SystemException

buildCareCardActivityRequest

public CareCardActivityRequest buildCareCardActivityRequest()
                                                     throws SystemException
Builds a new instance of CareCardActivityRequest with activityRequestType set to ActivityRequestType.CARE_CARD

Returns:
CareCardActivityRequest - new CareCardActivityRequest instance
Throws:
SystemException
BusinessException

buildGeneralActivityRequest

public GeneralActivityRequest buildGeneralActivityRequest()
                                                   throws SystemException
Builds a new instance of GeneralActivityRequest with activityRequestType set to ActivityRequestType.GENERAL

Returns:
GeneralActivityRequest - new GeneralActivityRequest instance
Throws:
SystemException
BusinessException

buildForwardAddressActivityRequest

public ForwardAddressActivityRequest buildForwardAddressActivityRequest()
                                                                 throws SystemException
Builds a new instance of ForwardAddressActivityRequest with activityRequestType set to ActivityRequestType.FORWARD_ADDRESS

Returns:
ForwardAddressActivityRequest - new ForwardAddressActivityRequest instance
Throws:
SystemException
BusinessException

buildRefundOrGiftCertificateActivityRequest

public RefundOrGiftCertificateActivityRequest buildRefundOrGiftCertificateActivityRequest()
                                                                                   throws SystemException
Builds a new instance of RefundOrGiftCertificateActivityRequest with activityRequestType set to ActivityRequestType.REFUND

Returns:
RefundOrGiftCertificateActivityRequest - new RefundOrGiftCertificateActivityRequest instance
Throws:
SystemException
BusinessException

buildSpecialOrderActivityRequest

public SpecialOrderActivityRequest buildSpecialOrderActivityRequest()
                                                             throws SystemException
Builds a new instance of SpecialOrderActivityRequest with activityRequestType set to ActivityRequestType.SPECIAL_ORDER

Returns:
SpecialOrderActivityRequest - new SpecialOrderActivityRequest instance
Throws:
SystemException
BusinessException

buildReturnActivityRequest

public ReturnActivityRequest buildReturnActivityRequest()
                                                 throws SystemException
Builds a new instance of ReturnActivityRequest with activityRequestType set to ActivityRequestType.RETURN

Returns:
ReturnActivityRequest - new ReturnActivityRequest instance
Throws:
SystemException
BusinessException

buildLabelActivityRequest

public LabelActivityRequest buildLabelActivityRequest()
                                               throws SystemException
Builds a new instance of LabelActivityRequest with activityRequestType set to ActivityRequestType.LABEL

Returns:
LabelActivityRequest - new LabelActivityRequest instance
Throws:
SystemException
BusinessException

buildWismoActivityRequest

public WismoActivityRequest buildWismoActivityRequest()
                                               throws SystemException
Builds a new instance of WismoActivityRequest with activityRequestType set to ActivityRequestType.WISMO

Returns:
WismoActivityRequest - new WismoActivityRequest instance
Throws:
SystemException
BusinessException

buildPartialActivityRequest

public PartialActivityRequest buildPartialActivityRequest()
                                                   throws SystemException
Builds a new instance of PartialActivityRequest with activityRequestType set to ActivityRequestType.PARTIAL

Returns:
PartialActivityRequest - new PartialActivityRequest instance
Throws:
SystemException
BusinessException

buildItemInstructionsActivityRequest

public ItemInstructionsActivityRequest buildItemInstructionsActivityRequest()
                                                                     throws SystemException
Builds a new instance of ItemActivityRequest with activityRequestType set to ActivityRequestType.ITEMINSTRUCTIONS

Returns:
ItemInstructionsActivityRequest - new ItemInstructionsActivityRequest instance
Throws:
SystemException
BusinessException

buildCustomerPLCCCreditApplicationInstance

public CustomerPLCCCreditApplication buildCustomerPLCCCreditApplicationInstance(Customer customer)
                                                                         throws SystemException,
                                                                                BusinessException
Builds a customer credit application for a customer

Returns:
CustomerCreditApplication - new CustomerCreditApplication instance
Throws:
SystemException
BusinessException

findAllCatalogTypes

public java.util.Set findAllCatalogTypes()
                                  throws SystemException
Finds all active CatalogTypes

Returns:
Set - resulting set of Catalog types
Throws:
SystemException

find

public java.util.Set find(CatalogTypeSearchCriteria criteria)
                   throws InvalidSearchCriteriaException,
                          SystemException
Finds all CatalogTypes based on search criteria

Returns:
Set - resulting set of Catalog types
Throws:
SystemException
InvalidSearchCriteriaException

findMatchingCustomers

public java.util.Set findMatchingCustomers(CustomerMatchCriteria criteria)
                                    throws BusinessException,
                                           SystemException
If MatchCodeFunctionality is active, finds all customers that match the criteria param value according to the current MatchRules.

Returns:
Set - resulting set of matching Customers
Throws:
SystemException
BusinessException

buildExportCustomerMergeRequestInstance

public CustomerMergeRequest buildExportCustomerMergeRequestInstance(Customer activeCustomer,
                                                                    User user)
                                                             throws SystemException
Builds a new instance of CustomerMergeRequest.

Parameters:
activeCustomer - value for new CustomerMergeRequest activeCustomer.
user - created by user
Returns:
CustomerMergeRequest new CustomerMergeRequest instance
Throws:
SystemException

buildImportCustomerMergeRequestInstance

public CustomerMergeRequest buildImportCustomerMergeRequestInstance(java.lang.String externalRequestId,
                                                                    DistributedReference activeCustomerRef,
                                                                    User user)
                                                             throws SystemException
Builds a new instance of CustomerMergeRequest.

Parameters:
externalRequestId - external request identifier
activeCustomerRef - reference for active customer
user - reference for created by user
Returns:
CustomerMergeRequest new CustomerMergeRequest instance
Throws:
SystemException

findCustomerMergeRequestReferences

public java.util.Set findCustomerMergeRequestReferences(CustomerMergeRequestSearchCriteria criteria)
                                                 throws SystemException
Finds existing CustomerMergeRequest references based on search critiera.

Returns:
Set - matching customer merge request references
Throws:
SystemException

updateCustomerMergeRequestsForSuccessfulExport

public void updateCustomerMergeRequestsForSuccessfulExport(java.util.Set requestRefs)
                                                    throws SystemException
Update customer merge requests for successful export.

Throws:
SystemException

updateCatalogRequestsForSuccessfulExport

public void updateCatalogRequestsForSuccessfulExport(java.util.Set requestRefs)
                                              throws SystemException
Update catalog request for successful export.

Throws:
SystemException

processCustomerMergeRequest

public void processCustomerMergeRequest(CustomerMergeRequest request)
                                 throws SystemException,
                                        BusinessException
Process a customer merge request.

Parameters:
request - customer merge request to process.
Throws:
SystemException
BusinessException

mergeCustomers

public void mergeCustomers(java.lang.String activeCustomerId,
                           java.util.Set mergeCustomerIds)
                    throws BusinessException,
                           SystemException
Merges information from the set of mergeCustomers into the activeCustomer

Parameters:
activeCustomerId - - id customer for merging changes into
mergeCustomerIds - - id's for customers whose data is to be merged into activeCustomerId
Throws:
SystemException
BusinessException

findOpenActivityRequests

public java.util.Set findOpenActivityRequests()
                                       throws SystemException
Finds all activity requests of the following types that have not yet been closed: CareCardActivityRequest GeneralActivityRequest RefundOrGiftCertificateActivityRequest SpecialOrderActivityRequest

Returns:
Set - resulting set of ActivityRequests
Throws:
SystemException

findAllActivityRequestTypes

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

readGeneralActivityRequestType

public ActivityRequestType readGeneralActivityRequestType()
                                                   throws SystemException
Throws:
SystemException

cashOutStoredValueCardForCustomer

public StoredValueCardCashoutResponse cashOutStoredValueCardForCustomer(java.lang.String number,
                                                                        java.lang.String pin,
                                                                        Customer customer,
                                                                        User user)
                                                                 throws BusinessException,
                                                                        SystemException
Throws:
BusinessException
SystemException

findAllStoredValueCardCashoutsForSalesAuditExport

public java.util.Set findAllStoredValueCardCashoutsForSalesAuditExport()
                                                                throws SystemException
Find all stored value card cashouts marked as 'R'eady for sales audit export.

Returns:
Set
Throws:
SystemException


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