com.highdeal.tax.hci

Class TaxHelper

java.lang.Object

com.highdeal.tax.hci.TaxHelper

public class TaxHelper
extends java.lang.Object

Tax helper in order to allows the tax computation. The helper is in charge of retrieve the good tax framework implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAX_PRECISION_KEY
static java.lang.String	TAX_ROUNDING_MODE_KEY

Constructor Summary

Constructors

Constructor and Description
TaxHelper()

Method Summary

Modifier and Type	Method and Description
void	addTaxFramework(com.highdeal.tax.Tax.TaxationModule taxationModule, com.highdeal.tax.TaxFramework taxFramework)
void	applyTax(ChargedTransaction transac, TaxedAmount taxedAmount) Applies tax(es) on a charged transaction.
Money	calculateNet(Money grossAmount, Transaction transaction, com.highdeal.tax.TaxInfoEntity taxInfo) Calculates the net amount from a gross amount.
TaxedAmount	calculateTax(Transaction transac, com.highdeal.tax.TaxInfoEntity taxInfo, boolean isPrepaidAccTaxExclUsingSubs) Calculates tax(es) for a charged transaction.
TaxedAmount	calculateTax(Transaction transac, com.highdeal.tax.VatDataEntity vatData, com.highdeal.tax.EztaxDataEntity eztaxData, boolean isPrepaidAccTaxExclUsingSubs) Calculates tax(es) for a charged transaction.
static boolean	checkTaxParameters(TaxParameterSetModel expected, TaxParameterSetModel actual)
java.util.Vector<TaxArea>	getAvailableTaxAreaList(java.util.Date at) Retrieves all tax area which are valid at the date "at".
java.util.Vector<TransServType>	getAvailableTransServTypeList() Retrieves all Transaction/Service Types which are valid for EZTax.
static TaxHelper	getInstance() Returns the TaxHelper instance.
com.highdeal.tax.TaxFramework	getTaxFramework(com.highdeal.tax.Tax.TaxationModule taxationModule)
int	getTaxPrecision(Currency fromCurrency) Gets the tax amount precision.
int	getTaxRoundingMode() Gets the tax rounding mode.
static com.highdeal.tax.TaxData	getUSInstance(java.lang.String taxDataStr)
void	initialize(java.util.List<com.highdeal.tax.Tax.TaxationModule> taxationModules, java.util.Properties props) Initializes the tax framework(s).
static boolean	isDifferentTaxPrefix(java.lang.String detailName, com.highdeal.tax.Tax.TaxationModule taxationModule)
boolean	isInitialized() Indicates if TaxHelper has been initialized, i.e.
static boolean	isValid(com.highdeal.tax.TaxData taxData)
boolean	refreshTransServTypeList() Refreshes all Transaction/Service Types which are valid for EZTax.
void	setTaxPrecision(int taxPrecision) Sets the tax amount precision.
void	setTaxRoundingMode(int taxRoundingMode) Sets the tax rounding mode.
void	storeTax(java.math.BigInteger transId, java.util.Date transDate, java.util.Date recordDate, java.lang.String vendor, java.lang.String buyer, java.util.List<TaxDetailModel> taxDetails, boolean prepaid) Stores tax(es) for a set of refill, prepaid or postpaid transactions.
static java.lang.String	toUSString(com.highdeal.tax.TaxData taxData)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAX_PRECISION_KEY

public static final java.lang.String TAX_PRECISION_KEY

See Also:

Constant Field Values

TAX_ROUNDING_MODE_KEY

public static final java.lang.String TAX_ROUNDING_MODE_KEY

See Also:

Constant Field Values

Constructor Detail

TaxHelper

public TaxHelper()

Method Detail

isInitialized

public boolean isInitialized()

Indicates if TaxHelper has been initialized, i.e. if a TaxFramework has been loaded.

Returns:

true if TaxHelper has been initialized, false otherwise.

isDifferentTaxPrefix

public static boolean isDifferentTaxPrefix(java.lang.String detailName,
                                           com.highdeal.tax.Tax.TaxationModule taxationModule)

getInstance

public static TaxHelper getInstance()

Returns the TaxHelper instance. This instance may not be initialized.

Returns:

the TaxHelper instance

initialize

public void initialize(java.util.List<com.highdeal.tax.Tax.TaxationModule> taxationModules,
                       java.util.Properties props)
                throws InvalidTaxException

Initializes the tax framework(s). If no tax framework is specified, the VAT tax framework is initialized.

Parameters:

taxationModules - the list of tax frameworks to initialize.

props - the tax properties to set (tax precision and tax rounding mode).

Throws:

InvalidTaxException

getTaxPrecision

public int getTaxPrecision(Currency fromCurrency)

Gets the tax amount precision.

Parameters:

fromCurrency - the currency use to apply the tax.

Returns:

the tax amount precision.

setTaxPrecision

public void setTaxPrecision(int taxPrecision)
                     throws InvalidTaxException

Sets the tax amount precision.

Parameters:

taxPrecision - the tax amount precision.

Throws:

InvalidTaxException

getTaxRoundingMode

public int getTaxRoundingMode()

Gets the tax rounding mode.

Returns:

the tax rounding mode.

setTaxRoundingMode

public void setTaxRoundingMode(int taxRoundingMode)
                        throws InvalidTaxException

Sets the tax rounding mode.

Parameters:

taxRoundingMode - the tax rounding mode.

Throws:

InvalidTaxException

calculateTax

public TaxedAmount calculateTax(Transaction transac,
                                com.highdeal.tax.VatDataEntity vatData,
                                com.highdeal.tax.EztaxDataEntity eztaxData,
                                boolean isPrepaidAccTaxExclUsingSubs)
                         throws InvalidTaxException

Calculates tax(es) for a charged transaction.

Parameters:

transac - the transaction on which the tax is applied.

vatData - the Value Added Tax information at the subscriber account level.

eztaxData - the US Telco Tax information at the external/prepaid account level.

isPrepaidAccTaxExclUsingSubs - indicates if the transaction has been generated for a prepaid account tax excl. having a subscription.

Returns:

the taxed amount.

Throws:

InvalidTaxException - if an error occurs during the computation of the tax.

calculateTax

public TaxedAmount calculateTax(Transaction transac,
                                com.highdeal.tax.TaxInfoEntity taxInfo,
                                boolean isPrepaidAccTaxExclUsingSubs)
                         throws InvalidTaxException

Calculates tax(es) for a charged transaction.

Parameters:

transac - the transaction on which the tax is applied.

taxInfo - the tax information at the subscriber account level.

isPrepaidAccTaxExclUsingSubs - indicates if the transaction has been generated for a prepaid account tax excl. having a subscription.

Returns:

the taxed amount.

Throws:

InvalidTaxException

calculateNet

public Money calculateNet(Money grossAmount,
                          Transaction transaction,
                          com.highdeal.tax.TaxInfoEntity taxInfo)
                   throws InvalidTaxException

Calculates the net amount from a gross amount.

Parameters:

grossAmount - the gross amount.

transaction - the transaction on which the tax is applied.

taxInfo - the tax information at the subscriber account level.

Returns:

the net amount.

Throws:

InvalidTaxException

applyTax

public void applyTax(ChargedTransaction transac,
                     TaxedAmount taxedAmount)

Applies tax(es) on a charged transaction. This function modify the charged transaction.

Parameters:

transac - the charged transaction for which the tax is applied.

taxedAmount - the taxed amount to apply on the charged transaction.

Throws:

IncompatibleCurrenciesException

storeTax

public void storeTax(java.math.BigInteger transId,
                     java.util.Date transDate,
                     java.util.Date recordDate,
                     java.lang.String vendor,
                     java.lang.String buyer,
                     java.util.List<TaxDetailModel> taxDetails,
                     boolean prepaid)
              throws InvalidTaxException

Stores tax(es) for a set of refill, prepaid or postpaid transactions. This function is used by the US tax framework.

Throws:

InvalidTaxException

getAvailableTaxAreaList

public java.util.Vector<TaxArea> getAvailableTaxAreaList(java.util.Date at)

Retrieves all tax area which are valid at the date "at". This function is used by the VAT tax framework only.

Parameters:

at - the date when the tax area must be valid.

Returns:

a vector with all tax valid at the data "at".

getAvailableTransServTypeList

public java.util.Vector<TransServType> getAvailableTransServTypeList()

Retrieves all Transaction/Service Types which are valid for EZTax. This function is used by the US tax framework only.

Returns:

a vector with all Transaction/Service Types valid for EZTax.

refreshTransServTypeList

public boolean refreshTransServTypeList()

Refreshes all Transaction/Service Types which are valid for EZTax. This function is used by the US tax framework.

Returns:

a boolean.

addTaxFramework

public void addTaxFramework(com.highdeal.tax.Tax.TaxationModule taxationModule,
                            com.highdeal.tax.TaxFramework taxFramework)

getTaxFramework

public com.highdeal.tax.TaxFramework getTaxFramework(com.highdeal.tax.Tax.TaxationModule taxationModule)

isValid

public static final boolean isValid(com.highdeal.tax.TaxData taxData)

toUSString

public static final java.lang.String toUSString(com.highdeal.tax.TaxData taxData)

getUSInstance

public static final com.highdeal.tax.TaxData getUSInstance(java.lang.String taxDataStr)

checkTaxParameters

public static final boolean checkTaxParameters(TaxParameterSetModel expected,
                                               TaxParameterSetModel actual)