com.retek.component.customer
Interface CustomerMergeRequest

All Superinterfaces:
BusinessObject, DistributedObject

public interface CustomerMergeRequest
extends DistributedObject

This class is the request that invokes the customer merge process, and holds information about the customers being merged.


Field Summary
static java.lang.String DISPLAY_CODE
           
static java.lang.String MERGE_CUSTOMERS
           
static java.lang.String REQUEST_TYPE
           
 
Method Summary
 void addMergeCustomer(Customer mergeCustomer)
          Add a merge customer to the merge request.
 Customer getActiveCustomer()
          Return the active (primary) customer for the merge request.
 RDate getCreateDate()
          Return the date the merge request was created.
 User getCreatedByUser()
          Return the user that created the merge request.
 java.lang.String getDisplayCode()
          Return the display code (external identifier) for the customer merge request.
 java.util.Set getMergeCustomers()
          Return the merge customers for the merge request.
 RDate getProcessedDate()
          Return the date the request was processed (either the date it was exported if it is an 'Export' request OR the date the merge was processed if it is an 'Import' request).
 CustomerMergeRequestType getRequestType()
          Return the type for the customer merge request.
 boolean isProcessed()
          Return boolean indicating if the request was processed (either exported or imported).
 void markProcessed()
          Mark the merge request as processed.
 void submit()
          Submit the customer merge request.
 
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

REQUEST_TYPE

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

DISPLAY_CODE

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

MERGE_CUSTOMERS

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

getDisplayCode

public java.lang.String getDisplayCode()
                                throws SystemException
Return the display code (external identifier) for the customer merge request.

Returns:
String external display code
Throws:
SystemException

getRequestType

public CustomerMergeRequestType getRequestType()
                                        throws SystemException
Return the type for the customer merge request. Can be an 'Import' merge request from an external system or an 'Export' merge request.

Returns:
CustomerMergeRequestType request type
Throws:
SystemException

getCreateDate

public RDate getCreateDate()
                    throws SystemException
Return the date the merge request was created.

Returns:
RDate create date
Throws:
SystemException

getCreatedByUser

public User getCreatedByUser()
                      throws SystemException
Return the user that created the merge request.

Returns:
User created by user
Throws:
SystemException

getProcessedDate

public RDate getProcessedDate()
                       throws SystemException
Return the date the request was processed (either the date it was exported if it is an 'Export' request OR the date the merge was processed if it is an 'Import' request).

Returns:
RDate processed date
Throws:
SystemException

isProcessed

public boolean isProcessed()
                    throws SystemException
Return boolean indicating if the request was processed (either exported or imported).

Returns:
boolean true if request was processed
Throws:
SystemException

getActiveCustomer

public Customer getActiveCustomer()
                           throws SystemException
Return the active (primary) customer for the merge request. The customer that will be kept in the system.

Returns:
Customer active customer
Throws:
SystemException

getMergeCustomers

public java.util.Set getMergeCustomers()
                                throws SystemException
Return the merge customers for the merge request. The customs that will be merged into the active (primary) customer.

Returns:
Set merge customers
Throws:
SystemException

markProcessed

public void markProcessed()
                   throws SystemException
Mark the merge request as processed.

Throws:
SystemException

addMergeCustomer

public void addMergeCustomer(Customer mergeCustomer)
                      throws SystemException
Add a merge customer to the merge request.

Parameters:
mergeCustomer - customer to be merged
Throws:
SystemException

submit

public void submit()
            throws SystemException,
                   BusinessException
Submit the customer merge request.

Throws:
SystemException
BusinessException


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25