com.highdeal.tax.hci

Class TaxArea

java.lang.Object

com.highdeal.tax.hci.TaxArea

All Implemented Interfaces:

XMLMarshallable

public class TaxArea
extends java.lang.Object
implements XMLMarshallable

This class represents a geographic location where a tax could exist.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="taxArea">
   <xs:complexType>
     <xs:attribute name="stateName" type="xs:string"/>
     <xs:attribute name="countyName" type="xs:string"/>
     <xs:attribute name="taxCode" type="xs:string"/>
     <xs:attribute name="countryCode" type="xs:string"/>
     <xs:attribute name="countryName" type="xs:string"/>
     <xs:attribute name="cityName" type="xs:string"/>
     <xs:attribute name="stateCode" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
TaxArea() Builds an empty tax area.
TaxArea(java.lang.String countryCode, java.lang.String zipCode) Builds a tax area from a party address.
TaxArea(java.lang.String countryCode, java.lang.String countryName, java.lang.String stateCode, java.lang.String stateName, java.lang.String countyName, java.lang.String cityName, java.lang.String zipCode, java.lang.String taxCode) Builds a tax area.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	buildTaxCode() Builds a tax code (with normal tax rate) from the current tax area.
java.lang.String	buildTaxCode(int rateType) Builds a tax code (with a specified tax rate) from the current tax area.
java.lang.String	getCityName() Returns the city name of the city which contains this area.
java.lang.String	getCountryCode() Returns the country code of the country which contains this area.
java.lang.String	getCountryName() Returns the name of the country which contains this area.
java.lang.String	getCountyName() Returns the county name of the county which contains this area.
java.lang.String	getLabel() Gets the label.
java.lang.String	getStateCode() Returns the code of the state which contains this area.
java.lang.String	getStateName() Returns the state name of the state which contains this area.
java.lang.String	getTaxCode() Gets the tax code.
java.lang.String	getZipCode() Gets the zip code.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxArea

public TaxArea()

Builds an empty tax area.

TaxArea

public TaxArea(java.lang.String countryCode,
               java.lang.String countryName,
               java.lang.String stateCode,
               java.lang.String stateName,
               java.lang.String countyName,
               java.lang.String cityName,
               java.lang.String zipCode,
               java.lang.String taxCode)

Builds a tax area.

Parameters:

countryCode - The ISO code of the country

countryName - The name of the country

stateCode - The code of a state into a given country

stateName - The name of the state

countyName - The name of the targetted county

cityName - The name of the city

zipCode - The zip code

TaxArea

public TaxArea(java.lang.String countryCode,
               java.lang.String zipCode)

Builds a tax area from a party address.

Parameters:

countryCode - The ISO code of the country

zipCode - The zip code

Method Detail

getCountryCode

public java.lang.String getCountryCode()

Returns the country code of the country which contains this area. NULL otherwise.

getCountryName

public java.lang.String getCountryName()

Returns the name of the country which contains this area. NULL otherwise.

getStateCode

public java.lang.String getStateCode()

Returns the code of the state which contains this area. NULL otherwise.

getStateName

public java.lang.String getStateName()

Returns the state name of the state which contains this area. NULL otherwise.

getCountyName

public java.lang.String getCountyName()

Returns the county name of the county which contains this area. NULL otherwise.

getCityName

public java.lang.String getCityName()

Returns the city name of the city which contains this area. NULL otherwise.

getZipCode

public java.lang.String getZipCode()

Gets the zip code.

Returns:

The zip code

getTaxCode

public java.lang.String getTaxCode()

Gets the tax code.

Returns:

The tax code

buildTaxCode

public java.lang.String buildTaxCode()

Builds a tax code (with normal tax rate) from the current tax area.

buildTaxCode

public java.lang.String buildTaxCode(int rateType)

Builds a tax code (with a specified tax rate) from the current tax area.

Parameters:

rateType - The targeted rate type. The available values are:

• Tax.VatRateCode.NORMAL_TAX_RATE
• Tax.VatRateCode.INTERMEDIARY_TAX_RATE
• Tax.VatRateCode.REDUCED_TAX_RATE
• Tax.VatRateCode.SUPER_REDUCED_TAX_RATE
• Tax.VatRateCode.ZERO_TAX_RATE
• Tax.VatRateCode.SPECIAL_TAX_RATE
• Tax.VatRateCode.NO_TAX_RATE_FLAG

getLabel

public java.lang.String getLabel()

Gets the label.

Returns:

The label

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into