com.konakartadmin.blif

Interface AdminAddressMgrIf

All Known Implementing Classes:

AdminAddressMgr

public interface AdminAddressMgrIf

AdminAddressMgrIf

Method Summary

Modifier and Type	Method and Description
void	addAddressesToProduct(AdminAddress[] addresses, int productId) Associate an array of addresses to a product.
void	deleteAddress(int addressId) Deletes an AdminAddress.
int	deleteAddressFormat(int id) Delete an AddressFormat
boolean	doesAddressExistForId(int addrId) Checks to see whether an address already exists with this id
boolean	doesAddressFormatExist(int addressFormatId) Return true if the AddressFormat exists.
AdminAddress	getAddressById(int addressId) Get Addresses defined by the search criteria
AdminAddressSearchResult	getAddresses(AdminAddressSearch search, int offset, int size) Get Addresses defined by the search criteria
AdminAddressFormatSearchResult	getAddressFormats(AdminAddressFormatSearch search) This returns an AdminAddressFormatSearchResult object.
int	getProductCountPerAddress(int addressId) Returns the number of products using the address
int	insertAddress(AdminAddress address) Insert an AdminAddress. KonaKart supports addresses for customers, products, manufacturers and stores.
int	insertAddressFormat(AdminAddressFormat taxClass) Insert an AdminAddressFormat object
void	refreshConfigs() Refresh the configuration of the Admin Currency Manager
void	removeAddressFromProduct(int addressId, int productId) Remove the relationship between the address and the product.
void	setAddressCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Sets address criteria
void	updateAddress(AdminAddress address) Updates an AdminAddress.
int	updateAddressFormat(AdminAddressFormat taxClass) Update an AdminAddressFormat object

Method Detail

getAddressFormats

AdminAddressFormatSearchResult getAddressFormats(AdminAddressFormatSearch search)
                                          throws KKAdminException

This returns an AdminAddressFormatSearchResult object.

Parameters:

search - the search

Returns:

Returns an AdminAddressFormatSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteAddressFormat

int deleteAddressFormat(int id)
                 throws KKAdminException

Delete an AddressFormat

Parameters:

id - An AddressFormat id

Returns:

returns the id of the deleted AddressFormat

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertAddressFormat

int insertAddressFormat(AdminAddressFormat taxClass)
                 throws KKAdminException

Insert an AdminAddressFormat object

Parameters:

taxClass - An AdminAddressFormat object

Returns:

returns the id of the inserted AdminAddressFormat object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateAddressFormat

int updateAddressFormat(AdminAddressFormat taxClass)
                 throws KKAdminException

Update an AdminAddressFormat object

Parameters:

taxClass - An AdminAddressFormat object

Returns:

returns the id of the updated AdminAddressFormat object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

doesAddressExistForId

boolean doesAddressExistForId(int addrId)
                       throws org.apache.torque.TorqueException,
                              KKAdminException

Checks to see whether an address already exists with this id

Parameters:

addrId - the addrId

Returns:

Returns true if the address already exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

doesAddressFormatExist

boolean doesAddressFormatExist(int addressFormatId)
                        throws org.apache.torque.TorqueException,
                               KKAdminException

Return true if the AddressFormat exists.

Parameters:

addressFormatId - the addressFormatId

Returns:

True if the category exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Admin Currency Manager

Throws:

java.lang.Exception - an unexpected exception

getAddresses

AdminAddressSearchResult getAddresses(AdminAddressSearch search,
                                      int offset,
                                      int size)
                               throws KKAdminException,
                                      org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException

Get Addresses defined by the search criteria

Parameters:

search - the search criteria

offset - the offset in the record set to start from

size - the maximum number of records to return

Returns:

an AdminAddressSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getAddressById

AdminAddress getAddressById(int addressId)
                     throws KKAdminException,
                            org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException

Get Addresses defined by the search criteria

Parameters:

addressId - the id of the address to retrieve

Returns:

the Address with the specified Id if it exists, otherwise null.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

insertAddress

int insertAddress(AdminAddress address)
           throws java.lang.Exception

Insert an AdminAddress.
KonaKart supports addresses for customers, products, manufacturers and stores. The following rules apply:

• If customerId > 0 the address is assumed to be that of a customer
• If manufacturerId > 0 the address is assumed to be that of a manufacturer
• If addrStoreId != null the address is assumed to be that of a store
• Otherwise we assume that the address may be used for a product. Many products may be associated to the same address (e.g. dropshipper address) so the product addresses are linked to products indirectly using a seperate DB table.

Parameters:

address - an AdminAddress object

Returns:

Returns the addresId of the newly-inserted AdminAddress

Throws:

java.lang.Exception - an unexpected exception

updateAddress

void updateAddress(AdminAddress address)
            throws KKAdminException

Updates an AdminAddress.

Parameters:

address - the AdminAddress object to update

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteAddress

void deleteAddress(int addressId)
            throws KKAdminException

Deletes an AdminAddress.

Parameters:

addressId - the id of the address to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addAddressesToProduct

void addAddressesToProduct(AdminAddress[] addresses,
                           int productId)
                    throws KKAdminException,
                           org.apache.torque.TorqueException,
                           com.workingdogs.village.DataSetException

Associate an array of addresses to a product.

Parameters:

addresses - the addresses

productId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

removeAddressFromProduct

void removeAddressFromProduct(int addressId,
                              int productId)
                       throws KKAdminException,
                              org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

Remove the relationship between the address and the product.

Parameters:

addressId - the addressId

productId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getProductCountPerAddress

int getProductCountPerAddress(int addressId)
                       throws com.workingdogs.village.DataSetException,
                              KKAdminException,
                              org.apache.torque.TorqueException

Returns the number of products using the address

Parameters:

addressId - the addressId

Returns:

Return the number of products using the address

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

setAddressCriteriaWithStandardAttributes

void setAddressCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)

Sets address criteria

Parameters:

c - the c