com.retek.component.tax.integration.taxengine
Interface TaxEngine

All Known Implementing Classes:
VertexTaxEngine

public interface TaxEngine

Interface that defines behavior of a TaxEngine.


Method Summary
 void calculate(TaxCalculatorInvoice taxInvoice, java.lang.String invoiceId, boolean forPersistence)
           
 void close()
          Method signals to the tax engine that interaction with it is done and no more calls to creditTax() or calculate() will be done.
 void creditTax(TaxCreditInvoice taxCreditInvoice, Money creditAmount)
           
 void init()
          Method signals to the tax engine that it should initialize itself for subsequent calls to creditTax() or calculate().
 

Method Detail

init

public void init()
          throws SystemException
Method signals to the tax engine that it should initialize itself for subsequent calls to creditTax() or calculate().

Throws:
SystemException

calculate

public void calculate(TaxCalculatorInvoice taxInvoice,
                      java.lang.String invoiceId,
                      boolean forPersistence)
               throws SystemException,
                      BusinessException
Parameters:
taxInvoice - The invoice to have tax calculated for.
invoiceId - The unique id for the invoice that taxs will be calculated for.
forPersistence - Signals tax engine that this invoice will be persisted.
Throws:
SystemException
BusinessException

creditTax

public void creditTax(TaxCreditInvoice taxCreditInvoice,
                      Money creditAmount)
               throws SystemException,
                      BusinessException
Parameters:
taxCreditInvoice - The invoice to have tax credited.
creditAmount - The amount to be credited.
Throws:
SystemException
BusinessException

close

public void close()
Method signals to the tax engine that interaction with it is done and no more calls to creditTax() or calculate() will be done.



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