com.konakartadmin.blif
Interface AdminAddressMgrIf

All Known Implementing Classes:

AdminAddressMgr

public interface AdminAddressMgrIf

AdminAddressMgrIf

Method Summary

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.
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	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 -

Returns:

Returns an AdminAddressFormatSearchResult object

Throws:

KKAdminException

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

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

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

doesAddressExistForId

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

Checks to see whether an address already exists with this id

Parameters:

addrId -

Returns:

Returns true if the address already exists

Throws:

org.apache.torque.TorqueException

KKAdminException

doesAddressFormatExist

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

Return true if the AddressFormat exists.

Parameters:

addressFormatId -

Returns:

True if the category exists

Throws:

org.apache.torque.TorqueException

KKAdminException

refreshConfigs

void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Currency Manager

Throws:

java.lang.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

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

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

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

insertAddress

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

Insert an AdminAddress.

Parameters:

address - an AdminAddress object

Returns:

Returns the addresId of the newly-inserted AdminAddress

Throws:

java.lang.Exception

updateAddress

void updateAddress(AdminAddress address)
                   throws KKAdminException

Updates an AdminAddress.

Parameters:

address - the AdminAddress object to update

Throws:

KKAdminException

deleteAddress

void deleteAddress(int addressId)
                   throws KKAdminException

Deletes an AdminAddress.

Parameters:

addressId - the id of the address to delete

Throws:

KKAdminException

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 -

productId -

Throws:

KKAdminException

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

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 -

productId -

Throws:

KKAdminException

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

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 -

Returns:

Return the number of products using the address

Throws:

com.workingdogs.village.DataSetException

KKAdminException

org.apache.torque.TorqueException