atg.integrations.taxware
Class TaxResult

java.lang.Object
  atg.integrations.taxware.FieldSet
      atg.integrations.taxware.TaxResult

public class TaxResult
extends atg.integrations.taxware.FieldSet

The TaxResult class represents the result of a request for tax information. It defines a few convenience functions for accessing commonly used properties, but allows the generic accessor functions for FieldSet to be used for other properties.

See the taxware documentation for a detailed description of what the various fields mean in practice.

Tax rate results are returned from taxware as strings with 6 decimal places, so one should divide by 1,000,000 to get the actual tax rate.

See Also:

TaxRequest, SalesTaxCaller, FieldSet, OutputRecordDef

Field Summary

static java.lang.String	CLASS_VERSION
protected static atg.integrations.taxware.RecordDef	m_recordDef Hold our record definition.

Method Summary

protected void	createRecordDef() Create out record definition
double	getCityTaxAmount() Return the city tax amount as an int.
double	getCityTaxBasisAmount() Return the city tax basis amount as an int.
double	getCityTaxRate() Return the city tax rate as an int..
double	getCountryTaxAmount() Return the country tax amount.
double	getCountryTaxBasisAmount() Return the country tax basis amount.
double	getCountryTaxRate() Return the country tax rate.
double	getCountyTaxAmount() Return the county tax amount.
double	getCountyTaxBasisAmount() Return the county tax basis amount.
double	getCountyTaxRate() Return the county tax rate.
long	getGeneralCompletionCode() Return the general completion code.
java.lang.String	getGeneralCompletionCodeDescription() Return the general completion code description.
double	getProvinceTaxAmount() Return the province(state) tax amount.
double	getProvinceTaxBasisAmount() Return the province(state) tax basis amount.
double	getProvinceTaxRate() Return the province(state) tax rate.
double	getSecCityTaxAmount() Return the secondary city tax amount as an int.
double	getSecCityTaxBasisAmount() Return the secondary city tax basis amount as an int.
double	getSecCityTaxRate() Return the secondary city tax rate as an int.
double	getSecCountyTaxAmount() Return the secondary county tax amount.
double	getSecCountyTaxBasisAmount() Return the secondary county tax basis amount.
double	getSecCountyTaxRate() Return the secondary county tax rate.
double	getSecProvinceTaxAmount() Return the secondary province(state) tax amount.
double	getSecProvinceTaxBasisAmount() Return the secondary province(state) tax basis amount.
double	getSecProvinceTaxRate() Return the secondary province(state) tax rate.
double	getTerritoryTaxAmount() Return the territory tax amount.
double	getTerritoryTaxBasisAmount() Return the territory tax basis amount.
double	getTerritoryTaxRate() Return the territory tax rate.
static void	main(java.lang.String[] rgArgs) Dump out field definitions
java.lang.String	toString()

Methods inherited from class atg.integrations.taxware.FieldSet

dumpFieldDefs, dumpFields, getBooleanFieldValue, getBooleanFieldValue, getBooleanFieldValue, getDateFieldValue, getDateFieldValue, getDateFieldValue, getDoubleFieldValue, getDoubleFieldValue, getDoubleFieldValue, getFieldValue, getFieldValue, getFieldValue, getFieldValueAs, getFieldValueAs, getFieldValueAs, getIntegerFieldValue, getIntegerFieldValue, getIntegerFieldValue, getLongFieldValue, getLongFieldValue, getLongFieldValue, getStringFieldValue, getStringFieldValue, getStringFieldValue, parseFields, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, writeFields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

m_recordDef

protected static atg.integrations.taxware.RecordDef m_recordDef

Hold our record definition.

Method Detail

createRecordDef

protected void createRecordDef()

Create out record definition

main

public static void main(java.lang.String[] rgArgs)

Dump out field definitions

getCountryTaxRate

public double getCountryTaxRate()

Return the country tax rate.

getTerritoryTaxRate

public double getTerritoryTaxRate()

Return the territory tax rate.

getProvinceTaxRate

public double getProvinceTaxRate()

Return the province(state) tax rate.

getCountyTaxRate

public double getCountyTaxRate()

Return the county tax rate.

getCityTaxRate

public double getCityTaxRate()

Return the city tax rate as an int..

getSecProvinceTaxRate

public double getSecProvinceTaxRate()

Return the secondary province(state) tax rate.

getSecCountyTaxRate

public double getSecCountyTaxRate()

Return the secondary county tax rate.

getSecCityTaxRate

public double getSecCityTaxRate()

Return the secondary city tax rate as an int.

getCountryTaxAmount

public double getCountryTaxAmount()

Return the country tax amount.

getTerritoryTaxAmount

public double getTerritoryTaxAmount()

Return the territory tax amount.

getProvinceTaxAmount

public double getProvinceTaxAmount()

Return the province(state) tax amount.

getCountyTaxAmount

public double getCountyTaxAmount()

Return the county tax amount.

getCityTaxAmount

public double getCityTaxAmount()

Return the city tax amount as an int.

getSecProvinceTaxAmount

public double getSecProvinceTaxAmount()

Return the secondary province(state) tax amount.

getSecCountyTaxAmount

public double getSecCountyTaxAmount()

Return the secondary county tax amount.

getSecCityTaxAmount

public double getSecCityTaxAmount()

Return the secondary city tax amount as an int.

getCountryTaxBasisAmount

public double getCountryTaxBasisAmount()

Return the country tax basis amount.

getTerritoryTaxBasisAmount

public double getTerritoryTaxBasisAmount()

Return the territory tax basis amount.

getProvinceTaxBasisAmount

public double getProvinceTaxBasisAmount()

Return the province(state) tax basis amount.

getCountyTaxBasisAmount

public double getCountyTaxBasisAmount()

Return the county tax basis amount.

getCityTaxBasisAmount

public double getCityTaxBasisAmount()

Return the city tax basis amount as an int.

getSecProvinceTaxBasisAmount

public double getSecProvinceTaxBasisAmount()

Return the secondary province(state) tax basis amount.

getSecCountyTaxBasisAmount

public double getSecCountyTaxBasisAmount()

Return the secondary county tax basis amount.

getSecCityTaxBasisAmount

public double getSecCityTaxBasisAmount()

Return the secondary city tax basis amount as an int.

getGeneralCompletionCode

public long getGeneralCompletionCode()

Return the general completion code.

getGeneralCompletionCodeDescription

public java.lang.String getGeneralCompletionCodeDescription()

Return the general completion code description.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object