The TaxOrderItemCmd interface provides an external tax calculation application with access to the tax-related data for an order item.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
static java.lang.String |
NAME The name of this command. |
Method Summary | |
---|---|
java.math.BigDecimal |
getCost() The total cost for this order item. |
java.math.BigDecimal |
getDiscount() The total value of all non-tax-exempt discounts for this line item. |
java.lang.String[] |
getJurisdictionCodes() Obtains all the jurisdiction levels (codes) where the taxes are being calculated. |
java.lang.String |
getJurstCode(java.lang.String aJurisdictiontype) Obtains the jurisdiction level (code) for a given type of jurisdiction level.. |
java.lang.String[] |
getSecondaryJurisdictionCodes() Obtains all the secondary jurisdiction levels (secondary codes) where the taxes are being calculated. |
java.lang.String |
getSecondaryJurstCode(java.lang.String aJurisdictiontype) Obtains the secondary jurisdiction level (code) for a given type of secondary jurisdiction level.. |
java.math.BigDecimal |
getSecondaryTax(java.lang.String aJurisdictiontype) Obtains the tax calculated for a given type of secondary jurisdiction level.. |
java.math.BigDecimal[] |
getSecondaryTaxAmounts() Obtains the tax amounts calculated for each of the given secondary jurisdiction levels returned from the tax calculation modules. |
java.math.BigDecimal |
getTax(java.lang.String aJurisdictiontype) Obtains the tax calculated for a given type of jurisdiction level.. |
java.math.BigDecimal[] |
getTaxAmounts() Obtains the tax amounts calculated for each of the given jurisdiction levels returned from the tax calculation modules. |
java.lang.Integer[] |
getTaxTypes() Obtains all the taxing authority or jurisdiction levels where the taxes calculated. |
java.math.BigDecimal |
getTotalTax() Obtains the total tax calculated for this order item for all relevant taxing authorities. |
void |
setAuditFlag(boolean aFlag) Turns on or off the audit (logging) of tax calculations for this order item. |
void |
setBusinessName(java.lang.String aBusinessName) This method provides the name of the particular business location which sells the order item. |
void |
setBuyerName(java.lang.String aName) The name of the purchaser for this item. |
void |
setCost(java.math.BigDecimal aItemCost) The total cost for this order item. |
void |
setCurrencyCode(java.lang.String aisoCurrency) This 3-character ISO currency code identifies the currency in which the transaction is being made. |
void |
setDiscount(java.math.BigDecimal aItemDiscount) The total value of all non-tax-exempt discounts for this line item. |
void |
setFreight(java.math.BigDecimal aItemFreight) The total sbipping charge for this order item. |
void |
setInvoiceNumber(java.lang.String aInvoiceNo) This method provides the ability to attach an identifier to the order item It is not used in the actual tax calculation. |
void |
setItemCnt(java.lang.Double aItemCnt) The number of units of this order item being purchased. |
void |
setSellerID(java.lang.String aSellerId) This method is used to set the seller identification. |
void |
setSellerRegistrationId(java.lang.String aSellerRegistrationId) This method is used to provide a seller registration identifier. |
void |
setShipFromAddress(java.lang.String aAddress) Sets the street address from which the order item will be shipped. |
void |
setShipFromCity(java.lang.String aCity) Sets the city portion of the address from which the order item will be shipped. |
void |
setShipFromCountry(java.lang.String aCountry) Sets the country from which the order item will be shipped. |
void |
setShipFromState(java.lang.String aState) Sets the state portion of the address from which the order item will be shipped. |
void |
setShipFromTaxGeoCode(java.lang.String aGeoCode) Sets the tax jurisdiction code (geoCode) from which the order item will be shipped. |
void |
setShipFromZip(java.lang.String aZipCode) Sets the zip code or postal code of the address from which the order item will be shipped. |
void |
setShipToAddress(java.lang.String aAddress) Sets the street address to which the order item will be shipped. |
void |
setShipToCity(java.lang.String aCity) Sets the city portion of the address to which the order item will be shipped. |
void |
setShipToCountry(java.lang.String aCountry) Sets the country to which the order item will be shipped. |
void |
setShipToState(java.lang.String aState) Sets the state portion of the address to which the order item will be shipped. |
void |
setShipToTaxGeoCode(java.lang.String aGeoCode) Sets the tax jurisdiction code (geoCode) to which the order item will be shipped. |
void |
setShipToZip(java.lang.String aZipCode) Sets the zip code or postal code of the address to which the order item will be shipped. |
void |
setStoreId(java.lang.Integer aStoreId) Sets the id of the input store to be used for determining the tax types. |
void |
setTaxCode(java.lang.String aTaxCode) This method specifies the tax treatment code for this order item. |
void |
setTransactionType(char aType)
This method is used to tell the tax software the type of
transaction. |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String NAME
Method Detail |
---|
public java.math.BigDecimal getCost()
public java.math.BigDecimal getDiscount()
public java.lang.String[] getJurisdictionCodes()
public java.lang.String getJurstCode(java.lang.String aJurisdictiontype)
aJurisdictiontype
- the type of jurisdiction level. Accepted
types can be "COUNTRY", "TERRITORY", "STATE",
"COUNTY", "CITY" and "DISTRICT".
public java.lang.String[] getSecondaryJurisdictionCodes()
public java.lang.String getSecondaryJurstCode(java.lang.String aJurisdictiontype)
aJurisdictiontype
- the type of jurisdiction level. Accepted
types can be "SECONDARYSTATE", "SECONARYCOUNTY",
"SECONDARYCITY".
public java.math.BigDecimal getSecondaryTax(java.lang.String aJurisdictiontype)
aJurisdictiontype
- the type of secondary jurisdiction level.
Accepted types can be "SECONDARYSTATE", "SECONARYCOUNTY",
"SECONDARYCITY".
public java.math.BigDecimal[] getSecondaryTaxAmounts()
public java.math.BigDecimal getTax(java.lang.String aJurisdictiontype)
aJurisdictiontype
- the type of jurisdiction level. Accepted
types can be "COUNTRY", "TERRITORY", "STATE",
"COUNTY", "CITY" and "DISTRICT".
public java.math.BigDecimal[] getTaxAmounts()
public java.lang.Integer[] getTaxTypes()
public java.math.BigDecimal getTotalTax()
public void setAuditFlag(boolean aFlag)
public void setBusinessName(java.lang.String aBusinessName)
public void setBuyerName(java.lang.String aName)
public void setCost(java.math.BigDecimal aItemCost)
public void setCurrencyCode(java.lang.String aisoCurrency)
public void setDiscount(java.math.BigDecimal aItemDiscount)
public void setFreight(java.math.BigDecimal aItemFreight)
aItemFreight
- The cost of shipping for this order
item.public void setInvoiceNumber(java.lang.String aInvoiceNo)
public void setItemCnt(java.lang.Double aItemCnt)
public void setSellerID(java.lang.String aSellerId)
public void setSellerRegistrationId(java.lang.String aSellerRegistrationId)
public void setShipFromAddress(java.lang.String aAddress)
public void setShipFromCity(java.lang.String aCity)
public void setShipFromCountry(java.lang.String aCountry)
public void setShipFromState(java.lang.String aState)
public void setShipFromTaxGeoCode(java.lang.String aGeoCode)
public void setShipFromZip(java.lang.String aZipCode)
public void setShipToAddress(java.lang.String aAddress)
public void setShipToCity(java.lang.String aCity)
public void setShipToCountry(java.lang.String aCountry)
public void setShipToState(java.lang.String aState)
public void setShipToTaxGeoCode(java.lang.String aGeoCode)
public void setShipToZip(java.lang.String aZipCode)
public void setStoreId(java.lang.Integer aStoreId)
aStoreId
- The reference number of a storepublic void setTaxCode(java.lang.String aTaxCode)
public void setTransactionType(char aType)
aType
- representing the type of transaction - valid values
are