public interface AdminTaxMgrIf
Modifier and Type | Method and Description |
---|---|
int |
deleteCountry(int id)
Delete a Country
|
int |
deleteGeoZone(int id)
Delete a Tax Area - and all it's mappings
|
int |
deleteSubZone(int id)
Delete a Zone
|
int |
deleteTaxClass(int id)
Delete a TaxClass
|
int |
deleteTaxRate(int id)
Delete a TaxRate
|
int |
deleteZone(int id)
Delete a Zone
|
boolean |
doesCountryExist(int id)
Checks to see whether a country already exists with this id
|
boolean |
doesGeoZoneExist(int id)
Return true if the zone exists.
|
boolean |
doesGeoZoneExist(int id,
java.sql.Connection con)
Return true if the zone exists.
|
boolean |
doesSubZoneExist(int id)
Return true if the zone exists.
|
boolean |
doesSubZoneExist(int id,
java.sql.Connection con)
Return true if the zone exists.
|
boolean |
doesTaxClassExist(int taxClassId)
Return true if the tax class exists.
|
boolean |
doesTaxClassExist(int taxClassId,
java.sql.Connection con)
Return true if the tax class exists.
|
boolean |
doesTaxRateExist(int id)
Return true if the zone exists.
|
boolean |
doesZoneExist(int id)
Return true if the zone exists.
|
boolean |
doesZoneExist(int id,
java.sql.Connection con)
Return true if the zone exists.
|
AdminCountry[] |
getAllCountriesFull()
Returns an array of fully populated countries.
|
AdminGeoZone[] |
getAllGeoZones()
Get an array of AdminGeoZones from the DB.
|
AdminTaxClass[] |
getAllTaxClassesFull()
Returns an array of all tax class objects.
|
AdminTaxRateSearchResult |
getAllTaxRates()
This returns an AdminTaxRateSearchResult object.
|
int |
getAllTaxRatesCount()
Returns a count of the number of TaxRates
|
AdminCountrySearchResult |
getCountries(AdminCountrySearch search,
int offset,
int size)
This returns an AdminCountrySearchResult object.
|
int |
getCountriesCount(AdminCountrySearch search)
Returns a count of the number of Countries
|
AdminCountry |
getCountryById(int countryId)
Returns the country object for the country id, or Null if the country doesn't exist in the
DB.
|
AdminCountry |
getCountryByName(java.lang.String countryName)
Returns the country object for the country name, or Null if the country doesn't exist in the
DB.
|
AdminGeoZoneSearchResult |
getGeoZones(AdminGeoZoneSearch search,
int offset,
int size)
This returns an AdminGeoZoneSearchResult object.
|
int |
getGeoZonesCount(AdminGeoZoneSearch search)
Returns a count of the number of Zones with the specified search criteria
|
AdminSubZoneSearchResult |
getSubZones(AdminSubZoneSearch search,
int offset,
int size)
This returns an AdminSubZoneSearchResult object.
|
int |
getSubZonesCount(AdminSubZoneSearch search)
Returns a count of the number of Zones with the specified search criteria
|
AdminTaxClassSearchResult |
getTaxClasses(AdminTaxClassSearch search)
This returns an AdminTaxClassSearchResult object.
|
int |
getTaxQuantityRule()
Returns the rule used to calculate tax for products with multiple quantities.
|
AdminTaxRateSearchResult |
getTaxRates(AdminTaxRateSearch search,
int offset,
int size)
This returns an AdminTaxRateSearchResult object.
|
int |
getTaxRatesCount(AdminTaxRateSearch search)
Returns a count of the number of TaxRates with the specified search criteria
|
int |
getTaxScale()
Returns the precision use for calculating tax that matches the ADMIN_CURRENCY_DECIMAL_PLACES
configuration variable.
|
AdminZone |
getZonePerCountryAndCode(int countryId,
java.lang.String zoneDesc)
The zone name and zone code is compared with the zoneDesc parameter in order to determine
whether a zone exists in the DB matching zoneDesc for the country defined by countryId.
|
AdminZone |
getZonePerId(int zoneId)
Returns the zone if it exists, otherwise null
|
AdminZoneSearchResult |
getZones(AdminZoneSearch search,
int offset,
int size)
This returns an AdminZoneSearchResult object.
|
AdminZone[] |
getZonesById(int countryId)
Returns an array of AdminZones in the specified country - fully-populated
|
int |
getZonesCount(AdminZoneSearch search)
Returns a count of the number of Zones with the specified search criteria
|
int |
insertCountry(AdminCountry country)
Insert an AdminCountry object
|
int |
insertGeoZone(AdminGeoZone insertObj)
Insert an AdminGeoZone object
|
int |
insertSubZone(AdminSubZone insertObj)
Insert an AdminSubZone object
|
int |
insertTaxClass(AdminTaxClass taxClass)
Insert an AdminTaxClass object
|
int |
insertTaxRate(AdminTaxRate insertObj)
Insert an AdminTaxRate object
|
int |
insertZone(AdminZone insertObj)
Insert an AdminZone object
|
void |
refreshConfigs()
Refresh the configuration of the Admin Currency Manager
|
int |
updateCountry(AdminCountry country)
Update an AdminCountry object
|
int |
updateGeoZone(AdminGeoZone updateObj)
Update an AdminGeoZone object
|
int |
updateSubZone(AdminSubZone updateObj)
Update an AdminSubZone object
|
int |
updateTaxClass(AdminTaxClass taxClass)
Update an AdminTaxClass object
|
int |
updateTaxRate(AdminTaxRate updateObj)
Update an AdminTaxRate object
|
int |
updateZone(AdminZone updateObj)
Update an AdminZone object
|
AdminCountry[] getAllCountriesFull() throws com.workingdogs.village.DataSetException, org.apache.torque.TorqueException, KKAdminException
com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminCountry getCountryByName(java.lang.String countryName) throws KKAdminException, org.apache.torque.TorqueException, com.workingdogs.village.DataSetException
countryName
- the countryNameKKAdminException
- an unexpected exception in the KonaKart Admin engineorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)AdminCountry getCountryById(int countryId) throws KKAdminException, org.apache.torque.TorqueException, com.workingdogs.village.DataSetException
countryId
- the countryIdKKAdminException
- an unexpected exception in the KonaKart Admin engineorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)AdminTaxClass[] getAllTaxClassesFull() throws com.workingdogs.village.DataSetException, org.apache.torque.TorqueException, KKAdminException
com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminTaxClassSearchResult getTaxClasses(AdminTaxClassSearch search) throws KKAdminException
search
- the searchKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteTaxClass(int id) throws KKAdminException
id
- A TaxClass idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertTaxClass(AdminTaxClass taxClass) throws KKAdminException
taxClass
- An AdminTaxClass objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateTaxClass(AdminTaxClass taxClass) throws KKAdminException
taxClass
- An AdminTaxClass objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesTaxClassExist(int taxClassId) throws org.apache.torque.TorqueException, KKAdminException
taxClassId
- the taxClassIdorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesTaxClassExist(int taxClassId, java.sql.Connection con) throws org.apache.torque.TorqueException, KKAdminException
taxClassId
- the taxClassIdcon
- Connection for transactionorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminZone[] getZonesById(int countryId) throws com.workingdogs.village.DataSetException, org.apache.torque.TorqueException, KKAdminException
countryId
- the countryIdcom.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminZone getZonePerCountryAndCode(int countryId, java.lang.String zoneDesc) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
countryId
- the countryIdzoneDesc
- the zoneDescorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminZone getZonePerId(int zoneId) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
zoneId
- the zoneIdorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminZoneSearchResult getZones(AdminZoneSearch search, int offset, int size) throws KKAdminException
search
- the definition of the search - can be nulloffset
- the offset in the dbsize
- the number of records from the specified offsetKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteZone(int id) throws KKAdminException
id
- A Zone idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertZone(AdminZone insertObj) throws KKAdminException
insertObj
- An AdminZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateZone(AdminZone updateObj) throws KKAdminException
updateObj
- An AdminZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesZoneExist(int id) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesZoneExist(int id, java.sql.Connection con) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idcon
- Connection for transactionorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getZonesCount(AdminZoneSearch search) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
search
- Search criteriaorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminGeoZone[] getAllGeoZones() throws java.lang.Exception
java.lang.Exception
- an unexpected exceptionAdminGeoZoneSearchResult getGeoZones(AdminGeoZoneSearch search, int offset, int size) throws KKAdminException
search
- the definition of the search - can be nulloffset
- the offset in the dbsize
- the number of records from the specified offsetKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteGeoZone(int id) throws KKAdminException
id
- A Tax Area idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertGeoZone(AdminGeoZone insertObj) throws KKAdminException
insertObj
- An AdminGeoZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateGeoZone(AdminGeoZone updateObj) throws KKAdminException
updateObj
- An AdminGeoZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesGeoZoneExist(int id) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesGeoZoneExist(int id, java.sql.Connection con) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idcon
- Connection for transactionorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getGeoZonesCount(AdminGeoZoneSearch search) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
search
- Search criteriaorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminSubZoneSearchResult getSubZones(AdminSubZoneSearch search, int offset, int size) throws KKAdminException
search
- the definition of the search - can be nulloffset
- the offset in the dbsize
- the number of records from the specified offsetKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteSubZone(int id) throws KKAdminException
id
- A Zone idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertSubZone(AdminSubZone insertObj) throws KKAdminException
insertObj
- An AdminSubZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateSubZone(AdminSubZone updateObj) throws KKAdminException
updateObj
- An AdminSubZone objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesSubZoneExist(int id) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesSubZoneExist(int id, java.sql.Connection con) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idcon
- Connection for transactionorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getSubZonesCount(AdminSubZoneSearch search) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
search
- Search criteriaorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getCountriesCount(AdminCountrySearch search) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
search
- Search criteriaorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminCountrySearchResult getCountries(AdminCountrySearch search, int offset, int size) throws KKAdminException
search
- the searchoffset
- the offset in the dbsize
- the number of records from the specified offsetKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteCountry(int id) throws KKAdminException
id
- A Country idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertCountry(AdminCountry country) throws KKAdminException
country
- An AdminCountry objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateCountry(AdminCountry country) throws KKAdminException
country
- An AdminCountry objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesCountryExist(int id) throws org.apache.torque.TorqueException, KKAdminException
id
- the country Idorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminTaxRateSearchResult getAllTaxRates() throws KKAdminException
KKAdminException
- an unexpected exception in the KonaKart Admin engineAdminTaxRateSearchResult getTaxRates(AdminTaxRateSearch search, int offset, int size) throws KKAdminException
search
- the definition of the search - can be nulloffset
- the offset in the dbsize
- the number of records from the specified offsetKKAdminException
- an unexpected exception in the KonaKart Admin engineint deleteTaxRate(int id) throws KKAdminException
id
- A TaxRate idKKAdminException
- an unexpected exception in the KonaKart Admin engineint insertTaxRate(AdminTaxRate insertObj) throws KKAdminException
insertObj
- An AdminTaxRate objectKKAdminException
- an unexpected exception in the KonaKart Admin engineint updateTaxRate(AdminTaxRate updateObj) throws KKAdminException
updateObj
- An AdminTaxRate objectKKAdminException
- an unexpected exception in the KonaKart Admin engineboolean doesTaxRateExist(int id) throws org.apache.torque.TorqueException, KKAdminException
id
- zone idorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getTaxRatesCount(AdminTaxRateSearch search) throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
search
- Search criteriaorg.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin engineint getAllTaxRatesCount() throws org.apache.torque.TorqueException, com.workingdogs.village.DataSetException, KKAdminException
org.apache.torque.TorqueException
- an unexpected exception in Torque (the database layer)com.workingdogs.village.DataSetException
- an unexpected exception due to data in Torque (the database layer)KKAdminException
- an unexpected exception in the KonaKart Admin enginevoid refreshConfigs() throws java.lang.Exception
java.lang.Exception
- an unexpected exceptionint getTaxQuantityRule() throws KKAdminException
KKAdminException
- an unexpected exception in the KonaKart Admin engineint getTaxScale() throws KKAdminException
KKAdminException
- an unexpected exception in the KonaKart Admin engineCopyright © 2018 DS Data Systems UK Ltd.