com.retek.component.payment
Interface PaymentSettlementManager

All Superinterfaces:
DistributedObjectManager

public interface PaymentSettlementManager
extends DistributedObjectManager


Method Summary
 PaymentSettlementCustomer buildPaymentSettlementCustomerInstance(PaymentSettlementTransactionContainer txnContainer)
           
 PaymentSettlementItem buildPaymentSettlementItemInstance(PaymentSettlementTransactionContainer txnContainer)
           
 PaymentSettlementPayment buildPaymentSettlementPaymentInstance(PaymentSettlementTransactionContainer txnContainer)
           
 PaymentSettlementTransactionContainer buildPaymentSettlementTransactionContainerInstance(java.lang.String settlementFileNumber, java.lang.String orderNumber)
           
 PaymentSettlementTransaction buildPaymentSettlementTransactionInstance(PaymentSettlementTransactionContainer txnContainer)
           
 java.util.Set findAllPaymentSettlementFileTransactions()
          Find all payment settlement transactions for all pending payment settlement files.
 PaymentSettlementFile findPaymentSettlementFile(java.lang.String settlementFileNumber)
          Find a payment settlement file for a given payment settlement file number.
 java.lang.String getNextSettlementFileNumber()
          Return the next settlement file number.
 PaymentSettlementFile readPaymentSettlementFile(DistributedReference paymentSettlementFileRef)
          Read a payment settlement file for a given reference.
 PaymentSettlementTransactionContainer readPaymentSettlementTransactionContainer(DistributedReference ref)
          Read a payment settlement order record set for a given reference.
 java.util.Set readPaymentSettlementTransactionContainers(java.util.Set refs)
          Read payment settlement transaction containers for a given set of references.
 void updateSettlementFileForSuccessfulExport(PaymentSettlementFile settlementFile, java.util.Set successfulTransactionContainerRefs)
          Update the payment settlement file record, mark it as processed and purge records from the payment settlement file staging table.
 
Methods inherited from interface com.retek.commons.component.DistributedObjectManager
getContext
 

Method Detail

buildPaymentSettlementTransactionContainerInstance

public PaymentSettlementTransactionContainer buildPaymentSettlementTransactionContainerInstance(java.lang.String settlementFileNumber,
                                                                                                java.lang.String orderNumber)
                                                                                         throws SystemException
Throws:
SystemException

buildPaymentSettlementTransactionInstance

public PaymentSettlementTransaction buildPaymentSettlementTransactionInstance(PaymentSettlementTransactionContainer txnContainer)
                                                                       throws SystemException
Throws:
SystemException

buildPaymentSettlementCustomerInstance

public PaymentSettlementCustomer buildPaymentSettlementCustomerInstance(PaymentSettlementTransactionContainer txnContainer)
                                                                 throws SystemException
Throws:
SystemException

buildPaymentSettlementItemInstance

public PaymentSettlementItem buildPaymentSettlementItemInstance(PaymentSettlementTransactionContainer txnContainer)
                                                         throws SystemException
Throws:
SystemException

buildPaymentSettlementPaymentInstance

public PaymentSettlementPayment buildPaymentSettlementPaymentInstance(PaymentSettlementTransactionContainer txnContainer)
                                                               throws SystemException
Throws:
SystemException

getNextSettlementFileNumber

public java.lang.String getNextSettlementFileNumber()
                                             throws SystemException
Return the next settlement file number. This is a public unique identifier for a given batch of settlement file records.

Returns:
String next settlement file number identifier (public identifier)
Throws:
SystemException

readPaymentSettlementFile

public PaymentSettlementFile readPaymentSettlementFile(DistributedReference paymentSettlementFileRef)
                                                throws SystemException
Read a payment settlement file for a given reference.

Parameters:
paymentSettlementFileRef - payment settlement file reference
Returns:
PaymentSettlementFile
Throws:
SystemException

findPaymentSettlementFile

public PaymentSettlementFile findPaymentSettlementFile(java.lang.String settlementFileNumber)
                                                throws SystemException
Find a payment settlement file for a given payment settlement file number.

Parameters:
settlementFileNumber - payment settlement file number
Returns:
PaymentSettlementFile payment settlement file
Throws:
SystemException

readPaymentSettlementTransactionContainer

public PaymentSettlementTransactionContainer readPaymentSettlementTransactionContainer(DistributedReference ref)
                                                                                throws SystemException
Read a payment settlement order record set for a given reference.

Returns:
PaymentSettlementTransactionContainer
Throws:
SystemException

readPaymentSettlementTransactionContainers

public java.util.Set readPaymentSettlementTransactionContainers(java.util.Set refs)
                                                         throws SystemException
Read payment settlement transaction containers for a given set of references.

Parameters:
refs - transaction container references
Returns:
Set PaymentSettlementTransactionContainer objects
Throws:
SystemException

findAllPaymentSettlementFileTransactions

public java.util.Set findAllPaymentSettlementFileTransactions()
                                                       throws SystemException
Find all payment settlement transactions for all pending payment settlement files.

Returns:
Set of payment settlement record sets
Throws:
SystemException

updateSettlementFileForSuccessfulExport

public void updateSettlementFileForSuccessfulExport(PaymentSettlementFile settlementFile,
                                                    java.util.Set successfulTransactionContainerRefs)
                                             throws SystemException
Update the payment settlement file record, mark it as processed and purge records from the payment settlement file staging table.

Parameters:
settlementFile - payment settlement file
successfulTransactionContainerRefs - successful transaction container references
Throws:
SystemException


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