com.highdeal.tax.hci

Class InvalidTaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.tax.hci.InvalidTaxException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidTaxException
extends OperationFailureException

Exception thrown when the methods for the description of an invalid tax exception.

Reasons

See the Field Summary section about the available reasons and troubleshooting information.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidTaxFault">
   <xs:complexType>
     <xs:attribute name="reason" type="InvalidTaxReasonType"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="InvalidTaxReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="requiredInfoMissingOrMalformed"/>
     <xs:enumeration value="noCountryTaxPolicyDefined"/>
     <xs:enumeration value="badRateValue"/>
     <xs:enumeration value="badCountryCode"/>
     <xs:enumeration value="invalidTaxDefinition"/>
     <xs:enumeration value="invalidTaxInitialization"/>
     <xs:enumeration value="invalidTaxFrameworkFeature"/>
     <xs:enumeration value="taxerNotAvailable"/>
     <xs:enumeration value="noVatTaxArea" />
     <xs:enumeration value="noEZTaxTSTypes"/>
     <xs:enumeration value="invalidTaxPrecision"/>
     <xs:enumeration value="invalidTaxRoundingMode"/>
     <xs:enumeration value="taxerCannotCalculateTax"/>
     <xs:enumeration value="badTaxRateCode"/>
     <xs:enumeration value="noVatRuleFound"/>
     <xs:enumeration value="missingSupplierCountryCode"/>
     <xs:enumeration value="missingCustomerCountryCode"/>
     <xs:enumeration value="missingBusinessCategory"/>
     <xs:enumeration value="missingB2bTaxationPlace"/>
     <xs:enumeration value="missingB2cTaxationPlace"/>
     <xs:enumeration value="invalidSupplierCountryCode"/>
     <xs:enumeration value="internalError"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAD_COUNTRY_CODE 3: Bad country code for tax code matching.
static int	BAD_RATE_VALUE 2: Bad rate value for this tax.
static int	BAD_TAX_RATE_CODE 19: Bad tax rate code.
static int	INTERNAL_ERROR -1: Other internal reasons.
static int	INVALID_SUPPLIER_COUNTRY_CODE 26: Invalid supplier country code.
static int	INVALID_TAX_DEFINITION 8: The tax data are not valid.
static int	INVALID_TAX_FRAMEWORK 10: Bad tax framework feature.
static int	INVALID_TAX_INIT 9: The tax framework initialization is not correct.
static int	INVALID_TAX_PRECISION 16: The specified tax precision is out of the supported range.
static int	INVALID_TAX_ROUNDING_MODE 17: The specified tax rounding mode is unknown.
static int	MISSING_B2B_TAXATION_PLACE 24: Missing B2B taxation place.
static int	MISSING_B2C_TAXATION_PLACE 25: Missing B2B taxation place.
static int	MISSING_BUSINESS_CATEGORY 23: Missing business category.
static int	MISSING_CUSTOMER_COUNTRY_CODE 22: Missing customer country code.
static int	MISSING_SUPPLIER_COUNTRY_CODE 21: Missing supplier country code.
static int	NO_COUNTRY_TAX_POLICY_DEFINED 1: No country tax policy defined for this country.
static int	NO_EZTAX_TS_TYPE 15: No EZTax transaction/service type available in database.
static int	NO_VAT_RULE_FOUND 20: No VAT rule available in database.
static int	NO_VAT_TAX_AREA 14: No VAT tax area available in database.
static int	REQUIRED_INFO_MISSING_OR_MALFORMED 0: Required information missing for retrieving tax code.
static int	TAXER_CANNOT_CALCULATE_TAX 18: The tax cannot be calculated.
static int	TAXER_NOT_AVAILABLE 13: Taxer not available.

Constructor Summary

Constructors

Constructor and Description
InvalidTaxException() Builds an InvalidTaxException.
InvalidTaxException(int reason) Builds an InvalidTaxException.
InvalidTaxException(int reason, java.lang.String message) Builds an InvalidTaxException.

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	getMessage() Gets the message.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
int	getReason() Returns the reason of the exception.
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.
java.lang.String	toString() Returns the reason of the exception in readable format.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_INFO_MISSING_OR_MALFORMED

public static final int REQUIRED_INFO_MISSING_OR_MALFORMED

0: Required information missing for retrieving tax code.

See Also:

Constant Field Values

NO_COUNTRY_TAX_POLICY_DEFINED

public static final int NO_COUNTRY_TAX_POLICY_DEFINED

1: No country tax policy defined for this country.

See Also:

Constant Field Values

BAD_RATE_VALUE

public static final int BAD_RATE_VALUE

2: Bad rate value for this tax.

See Also:

Constant Field Values

BAD_COUNTRY_CODE

public static final int BAD_COUNTRY_CODE

3: Bad country code for tax code matching.

See Also:

Constant Field Values

INVALID_TAX_DEFINITION

public static final int INVALID_TAX_DEFINITION

8: The tax data are not valid.

See Also:

Constant Field Values

INVALID_TAX_INIT

public static final int INVALID_TAX_INIT

9: The tax framework initialization is not correct.

See Also:

Constant Field Values

INVALID_TAX_FRAMEWORK

public static final int INVALID_TAX_FRAMEWORK

10: Bad tax framework feature.

See Also:

Constant Field Values

TAXER_NOT_AVAILABLE

public static final int TAXER_NOT_AVAILABLE

13: Taxer not available.

See Also:

Constant Field Values

NO_VAT_TAX_AREA

public static final int NO_VAT_TAX_AREA

14: No VAT tax area available in database.

See Also:

Constant Field Values

NO_EZTAX_TS_TYPE

public static final int NO_EZTAX_TS_TYPE

15: No EZTax transaction/service type available in database.

See Also:

Constant Field Values

INVALID_TAX_PRECISION

public static final int INVALID_TAX_PRECISION

16: The specified tax precision is out of the supported range.

See Also:

Constant Field Values

INVALID_TAX_ROUNDING_MODE

public static final int INVALID_TAX_ROUNDING_MODE

17: The specified tax rounding mode is unknown.

See Also:

Constant Field Values

TAXER_CANNOT_CALCULATE_TAX

public static final int TAXER_CANNOT_CALCULATE_TAX

18: The tax cannot be calculated.

See Also:

Constant Field Values

BAD_TAX_RATE_CODE

public static final int BAD_TAX_RATE_CODE

19: Bad tax rate code.

See Also:

Constant Field Values

NO_VAT_RULE_FOUND

public static final int NO_VAT_RULE_FOUND

20: No VAT rule available in database.

See Also:

Constant Field Values

MISSING_SUPPLIER_COUNTRY_CODE

public static final int MISSING_SUPPLIER_COUNTRY_CODE

21: Missing supplier country code.

See Also:

Constant Field Values

MISSING_CUSTOMER_COUNTRY_CODE

public static final int MISSING_CUSTOMER_COUNTRY_CODE

22: Missing customer country code.

See Also:

Constant Field Values

MISSING_BUSINESS_CATEGORY

public static final int MISSING_BUSINESS_CATEGORY

23: Missing business category.

See Also:

Constant Field Values

MISSING_B2B_TAXATION_PLACE

public static final int MISSING_B2B_TAXATION_PLACE

24: Missing B2B taxation place.

See Also:

Constant Field Values

MISSING_B2C_TAXATION_PLACE

public static final int MISSING_B2C_TAXATION_PLACE

25: Missing B2B taxation place.

See Also:

Constant Field Values

INVALID_SUPPLIER_COUNTRY_CODE

public static final int INVALID_SUPPLIER_COUNTRY_CODE

26: Invalid supplier country code.

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

-1: Other internal reasons.

See Also:

Constant Field Values

Constructor Detail

InvalidTaxException

public InvalidTaxException()

Builds an InvalidTaxException.

InvalidTaxException

public InvalidTaxException(int reason)

Builds an InvalidTaxException.

Parameters:

reason - The reason of the exception

InvalidTaxException

public InvalidTaxException(int reason,
                           java.lang.String message)

Builds an InvalidTaxException.

Parameters:

reason - The reason of the exception

message - The message of the exception

Method Detail

getReason

public int getReason()

Returns the reason of the exception.

Returns:

The reason of the exception

toString

public java.lang.String toString()

Returns the reason of the exception in readable format.

Overrides:

toString in class java.lang.Throwable

Returns:

A string describing the reason of the exception

getMessage

public java.lang.String getMessage()

Gets the message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The message

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

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.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

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

Parameters:

output - The XML output to marshal the object into

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result