com.retek.component.customerorder
Interface CustomerOrderPayment

All Superinterfaces:
BusinessObject, CustomerOrderTransactionItem, DistributedObject
All Known Subinterfaces:
CustomerOrderCashPayment, CustomerOrderCheckPayment, CustomerOrderCreditCardPayment, CustomerOrderGiftCertificatePayment, CustomerOrderMerchandiseCertificatePayment, CustomerOrderMoneyOrderPayment, CustomerOrderRewardCertificatePayment, CustomerOrderStoredValueCardPayment, CustomerOrderVoucherPayment
All Known Implementing Classes:
CustomerOrderCashPaymentImpl, CustomerOrderCheckPaymentImpl, CustomerOrderCreditCardPaymentImpl, CustomerOrderGiftCertificatePaymentImpl, CustomerOrderMerchandiseCertificatePaymentImpl, CustomerOrderMoneyOrderPaymentImpl, CustomerOrderPaymentImpl, CustomerOrderRewardCertificatePaymentImpl, CustomerOrderStoredValueCardPaymentImpl, CustomerOrderVoucherPaymentImpl

public interface CustomerOrderPayment
extends DistributedObject, CustomerOrderTransactionItem

This is a high level interface which relates a payment object to a customer order object. An order can have multiple CustomerOrderPayment and each CustomerOrderPayment will have only one Tender Type.

Retek Inc. Copyright (c) 2003


Field Summary
static java.lang.String AMOUNT
           
static java.lang.String SET_ORDER
           
static java.lang.String TENDER_TYPE
           
 
Method Summary
 void addSalesAuditExportAmount(Money used)
          Add to the Sales Audit export amount for the payment.
 void allocateSettlement(Money amount, RDate dateOfPurchase)
           
 void allocateSettlement(Money amount, RDate dateOfPurchase, ReturnLine returnLine)
           
 void allocateSettlement(Money amount, RDate dateOfPurchase, ShippedContainer container)
           
 void authorize()
           
 void authorize(Money amountToAuthorize)
           
 void authorizeManually(Money authorizeAmount, java.lang.String authCode, User user)
           
 void authorizeManually(java.lang.String authCode, User user)
           
 void cancel()
           
 void consolidatePayments(java.util.Set groupOfPayments)
           
 void finishSettlement(CustomerOrderSettlement settlement, java.lang.String settlementFileNumber)
           
 java.lang.String getAccountNumber()
           
 Money getAmount()
           
 Money getAuthorizedAmount()
           
 java.lang.String getCurrency()
           
 java.util.Set getHistoryEvents()
           
 CustomerOrder getOrder()
           
 Money getOriginalAuthorizedAmount()
           
 PaymentAuthorizationResponse getPaymentAuthorizationResponse()
           
 CustomerOrderPaymentTransactionType getPaymentTransactionType()
           
 TenderType getRedemptionTenderType()
          Return the tender type for the payment which is for use for a redemption tender record for use in a SALE transaction.
 CustomerAddress getRefundRecipientAddress()
          Return the refund recipient address for the refund payment.
 TenderType getRefundTenderType()
          Return the tender type for the payment which is for use for a refund tender record for use in a RETURN OR PAIDOU transaction.
 Money getSalesAuditExportAmount()
          Return the amount for the payment that has been exported as a TTEND record (tender) within a Sales Audit SALE or RETURN transaction.
 ExportState getSalesAuditPaidInState()
          Return the Sales Audit transaction trigger state for the payment with respect to PAIDIN liability transaction processing.
 ExportState getSalesAuditPaidOutState()
          Return the Sales Audit transaction trigger state for the payment with respect to PAIDOU liability transaction processing.
 RDate getSalesAuditTransactionDate()
          Return the transaction effective date for the payment for PAIDIN (sale payment) or PAIDOU (credit payment).
 CustomerOrderSettlement getSettlement()
           
 com.retek.fsm.State getState()
           
 TenderType getTenderType()
           
 java.lang.String getTransactionTypeCode()
           
 Money getUnauthorizedAmount()
           
 boolean hasUnauthorizedAmount()
           
 boolean isAmountAdjustable()
           
 boolean isAmountAdjustable(CustomerOrderTransactionItem transactionItem)
           
 boolean isApproved()
           
 boolean isCancelable()
           
 boolean isCancelled()
           
 boolean isCreditPayment()
           
 boolean isCreditPaymentForAccommodation()
           
 boolean isCreditPaymentForPostSaleAccommodation()
           
 boolean isCreditPaymentForPreSaleAccommodation()
           
 boolean isDeclined()
           
 boolean isFraud()
           
 boolean isManuallyApproved()
           
 boolean isPhysicalTender()
           
 boolean isPreSettled()
           
 boolean isReferral()
           
 boolean isSettled()
           
 boolean isWaitingAuth()
           
 boolean isWaitingManualAuth()
           
 void markCreditPaymentExportedForPaidOut()
          Mark a credit payment 'E'XPORTED for Sales Audit PAIDOU transaction processing.
 void markCreditPaymentReadyForPaidOutExport()
          Mark a credit payment 'R'EADY for Sales Audit PAIDOU transaction processing.
 void markSalePaymentExportedForPaidIn()
          Mark a sale payment 'E'XPORTED for Sales Audit PAIDIN transaction processing.
 void markSalePaymentReadyForPaidInExport()
          Mark a sale payment 'R'EADY for Sales Audit PAIDIN transaction processing.
 void setAmount(Money amount)
           
 void setAuthorizedAmount(Money authorizedAmount)
           
 void setCurrency(java.lang.String currency)
           
 void setOriginalAuthorizedAmount(Money authorizedAmount)
           
 void setPaymentTransactionType(CustomerOrderPaymentTransactionType paymentTransactionType)
           
 void setRefundRecipientAddress(CustomerAddress address)
          Set the recipient address for the refund payment.
 void setTransactionTypeCode(java.lang.String transactionTypeCode)
           
 
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
 
Methods inherited from interface com.retek.component.customerorder.CustomerOrderTransactionItem
getTransactionGroup, getTransactionItemAmount, isCreditForTransactionGroupBalance, isDebitForTransactionGroupBalance, isExchangeSaleLine, isInClosedTransactionGroup, isReplacementSaleLine, notifyTransactionGroupClosed, setTransactionGroup
 

Field Detail

AMOUNT

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

SET_ORDER

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

TENDER_TYPE

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

setAmount

public void setAmount(Money amount)
               throws SystemException,
                      BusinessException
Throws:
SystemException
BusinessException

getAmount

public Money getAmount()
                throws SystemException
Throws:
SystemException

allocateSettlement

public void allocateSettlement(Money amount,
                               RDate dateOfPurchase,
                               ReturnLine returnLine)
                        throws SystemException,
                               BusinessException
Throws:
SystemException
BusinessException

allocateSettlement

public void allocateSettlement(Money amount,
                               RDate dateOfPurchase,
                               ShippedContainer container)
                        throws SystemException,
                               BusinessException
Throws:
SystemException
BusinessException

allocateSettlement

public void allocateSettlement(Money amount,
                               RDate dateOfPurchase)
                        throws SystemException,
                               BusinessException
Throws:
SystemException
BusinessException

finishSettlement

public void finishSettlement(CustomerOrderSettlement settlement,
                             java.lang.String settlementFileNumber)
                      throws SystemException,
                             BusinessException
Throws:
SystemException
BusinessException

getSettlement

public CustomerOrderSettlement getSettlement()
                                      throws SystemException
Throws:
SystemException

getOrder

public CustomerOrder getOrder()
                       throws SystemException
Throws:
SystemException

getAccountNumber

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

getHistoryEvents

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

authorize

public void authorize()
               throws SystemException,
                      BusinessException
Throws:
SystemException
BusinessException

getState

public com.retek.fsm.State getState()
                             throws SystemException
Throws:
SystemException

isCancelable

public boolean isCancelable()
                     throws SystemException
Throws:
SystemException

isDeclined

public boolean isDeclined()
                   throws SystemException
Throws:
SystemException

isSettled

public boolean isSettled()
                  throws SystemException
Throws:
SystemException

isCancelled

public boolean isCancelled()
                    throws SystemException
Throws:
SystemException

isApproved

public boolean isApproved()
                   throws SystemException
Throws:
SystemException

isManuallyApproved

public boolean isManuallyApproved()
                           throws SystemException
Throws:
SystemException

isFraud

public boolean isFraud()
                throws SystemException
Throws:
SystemException

isReferral

public boolean isReferral()
                   throws SystemException
Throws:
SystemException

isPreSettled

public boolean isPreSettled()
                     throws SystemException
Throws:
SystemException

isCreditPayment

public boolean isCreditPayment()
                        throws SystemException
Throws:
SystemException

isWaitingAuth

public boolean isWaitingAuth()
                      throws SystemException
Throws:
SystemException

isWaitingManualAuth

public boolean isWaitingManualAuth()
                            throws SystemException
Throws:
SystemException

isAmountAdjustable

public boolean isAmountAdjustable()
                           throws SystemException
Throws:
SystemException

isAmountAdjustable

public boolean isAmountAdjustable(CustomerOrderTransactionItem transactionItem)
                           throws SystemException
Throws:
SystemException

getPaymentTransactionType

public CustomerOrderPaymentTransactionType getPaymentTransactionType()
                                                              throws SystemException
Throws:
SystemException

isCreditPaymentForAccommodation

public boolean isCreditPaymentForAccommodation()
                                        throws SystemException
Throws:
SystemException

isCreditPaymentForPostSaleAccommodation

public boolean isCreditPaymentForPostSaleAccommodation()
                                                throws SystemException
Throws:
SystemException

isCreditPaymentForPreSaleAccommodation

public boolean isCreditPaymentForPreSaleAccommodation()
                                               throws SystemException
Throws:
SystemException

cancel

public void cancel()
            throws SystemException,
                   BusinessException
Throws:
SystemException
BusinessException

getPaymentAuthorizationResponse

public PaymentAuthorizationResponse getPaymentAuthorizationResponse()
                                                             throws SystemException
Throws:
SystemException

authorizeManually

public void authorizeManually(java.lang.String authCode,
                              User user)
                       throws SystemException,
                              BusinessException
Throws:
SystemException
BusinessException

authorizeManually

public void authorizeManually(Money authorizeAmount,
                              java.lang.String authCode,
                              User user)
                       throws SystemException,
                              BusinessException
Throws:
SystemException
BusinessException

authorize

public void authorize(Money amountToAuthorize)
               throws SystemException,
                      BusinessException
Throws:
SystemException
BusinessException

getCurrency

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

getTransactionTypeCode

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

setCurrency

public void setCurrency(java.lang.String currency)
                 throws SystemException
Throws:
SystemException

setTransactionTypeCode

public void setTransactionTypeCode(java.lang.String transactionTypeCode)
                            throws SystemException
Throws:
SystemException

getTenderType

public TenderType getTenderType()
                         throws SystemException
Throws:
SystemException

getAuthorizedAmount

public Money getAuthorizedAmount()
                          throws SystemException
Throws:
SystemException

getUnauthorizedAmount

public Money getUnauthorizedAmount()
                            throws SystemException
Throws:
SystemException

hasUnauthorizedAmount

public boolean hasUnauthorizedAmount()
                              throws SystemException
Throws:
SystemException

getRefundRecipientAddress

public CustomerAddress getRefundRecipientAddress()
                                          throws SystemException
Return the refund recipient address for the refund payment. Will be null if the payment is not a credit payment OR if no refund recipient was explicitly set for the payment. If the refund recipient is not set for the payment, the CustomerOrder bill-to address will be used as the default.

Returns:
CustomerAddress refund recipient address
Throws:
SystemException

setRefundRecipientAddress

public void setRefundRecipientAddress(CustomerAddress address)
                               throws SystemException
Set the recipient address for the refund payment. This address is used when publishing the refund payment during the payment settlement process. If the refund recipient is not set for the payment, the CustomerOrder bill-to address will be used as the default.

Parameters:
address - refund recipient address
Throws:
SystemException

setPaymentTransactionType

public void setPaymentTransactionType(CustomerOrderPaymentTransactionType paymentTransactionType)
                               throws SystemException
Throws:
SystemException

setAuthorizedAmount

public void setAuthorizedAmount(Money authorizedAmount)
                         throws SystemException
Throws:
SystemException

consolidatePayments

public void consolidatePayments(java.util.Set groupOfPayments)
                         throws SystemException,
                                BusinessException
Throws:
SystemException
BusinessException

isPhysicalTender

public boolean isPhysicalTender()
                         throws SystemException
Throws:
SystemException

setOriginalAuthorizedAmount

public void setOriginalAuthorizedAmount(Money authorizedAmount)
                                 throws SystemException
Throws:
SystemException

getOriginalAuthorizedAmount

public Money getOriginalAuthorizedAmount()
                                  throws SystemException
Throws:
SystemException

getSalesAuditPaidInState

public ExportState getSalesAuditPaidInState()
                                     throws SystemException
Return the Sales Audit transaction trigger state for the payment with respect to PAIDIN liability transaction processing.

Returns:
ExportState sales audit trigger state
Throws:
SystemException

markSalePaymentReadyForPaidInExport

public void markSalePaymentReadyForPaidInExport()
                                         throws SystemException
Mark a sale payment 'R'EADY for Sales Audit PAIDIN transaction processing.

Throws:
SystemException

markSalePaymentExportedForPaidIn

public void markSalePaymentExportedForPaidIn()
                                      throws SystemException
Mark a sale payment 'E'XPORTED for Sales Audit PAIDIN transaction processing.

Throws:
SystemException

getSalesAuditPaidOutState

public ExportState getSalesAuditPaidOutState()
                                      throws SystemException
Return the Sales Audit transaction trigger state for the payment with respect to PAIDOU liability transaction processing.

Returns:
ExportState sales audit trigger state
Throws:
SystemException

markCreditPaymentReadyForPaidOutExport

public void markCreditPaymentReadyForPaidOutExport()
                                            throws SystemException
Mark a credit payment 'R'EADY for Sales Audit PAIDOU transaction processing.

Throws:
SystemException

markCreditPaymentExportedForPaidOut

public void markCreditPaymentExportedForPaidOut()
                                         throws SystemException
Mark a credit payment 'E'XPORTED for Sales Audit PAIDOU transaction processing.

Throws:
SystemException

getSalesAuditTransactionDate

public RDate getSalesAuditTransactionDate()
                                   throws SystemException
Return the transaction effective date for the payment for PAIDIN (sale payment) or PAIDOU (credit payment).

Returns:
RDate sales audit transaction effective date
Throws:
SystemException

getSalesAuditExportAmount

public Money getSalesAuditExportAmount()
                                throws SystemException
Return the amount for the payment that has been exported as a TTEND record (tender) within a Sales Audit SALE or RETURN transaction.

Returns:
Money sales audit export amount
Throws:
SystemException

addSalesAuditExportAmount

public void addSalesAuditExportAmount(Money used)
                               throws SystemException
Add to the Sales Audit export amount for the payment. This amount is only incremented when writing TTEND records as part of Sales Audit SALE OR RETURN transaction.

Parameters:
used - export amount used (for SALE or RETURN)
Throws:
SystemException

getRedemptionTenderType

public TenderType getRedemptionTenderType()
                                   throws SystemException
Return the tender type for the payment which is for use for a redemption tender record for use in a SALE transaction.

Returns:
TenderType redemption tender type
Throws:
SystemException

getRefundTenderType

public TenderType getRefundTenderType()
                               throws SystemException
Return the tender type for the payment which is for use for a refund tender record for use in a RETURN OR PAIDOU transaction.

Returns:
TenderType redemption tender type
Throws:
SystemException


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