com.konakartadmin.blif

Interface AdminWishListMgrIf

All Known Implementing Classes:

AdminWishListMgr

public interface AdminWishListMgrIf

AdminWishListMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteWishList(int wishListId) Delete a wishlist and all of its wishlist items.
void	deleteWishListItem(int wishListItemId) Delete a wishlist and all of its wishlist items.
AdminWishLists	getWishLists(AdminWishListSearch search, int offset, int size) Return the WishList objects defined by the search criteria.
int	insertWishList(AdminWishList wishList) Insert a wishlist and any attached wishlist items.
int	insertWishListItem(AdminWishListItem wishListItem) Insert an AdminWishListItem.
void	updateWishListItemQuantityBought(int wishListItemId, int quantityBought) Updates the wishListItem quantity received attribute by adding quantityBought to the actual value.

Method Detail

updateWishListItemQuantityBought

void updateWishListItemQuantityBought(int wishListItemId,
                                      int quantityBought)
                               throws org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException

Updates the wishListItem quantity received attribute by adding quantityBought to the actual value.

Parameters:

wishListItemId - the wishListItemId

quantityBought - the quantityBought

Throws:

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)

getWishLists

AdminWishLists getWishLists(AdminWishListSearch search,
                            int offset,
                            int size)
                     throws KKAdminException,
                            org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException,
                            java.lang.Exception

Return the WishList objects defined by the search criteria. If the includeChildren attribute on the AdminWishListSearch is true the WishListItem children on each WishList object are returned.

Parameters:

search - the AdminWishListSearch object that defines the wishlist objects to search for. If null we use the default AdminWishListSearch object.

offset - starting offset in database - so that you can page through results

size - size of the group that will be returned - the maximum number of records returned

Returns:

an AdminWishLists 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)

java.lang.Exception - an unexpected exception

insertWishList

int insertWishList(AdminWishList wishList)
            throws KKAdminException

Insert a wishlist and any attached wishlist items. This method is intended to be used for importing wishlists that have previously been validated and saved maybe in another KonaKart. It is used by the KonaKart XML import / export functionality.

Parameters:

wishList - the wishList

Returns:

Returns the wishlist Id of the newly-inserted wishlist

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteWishList

void deleteWishList(int wishListId)
             throws KKAdminException

Delete a wishlist and all of its wishlist items.

Parameters:

wishListId - the wishListId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertWishListItem

int insertWishListItem(AdminWishListItem wishListItem)
                throws KKAdminException

Insert an AdminWishListItem. This method is intended to be used for importing wishlists that have previously been validated and saved maybe in another KonaKart. It is used by the KonaKart XML import / export functionality.

Parameters:

wishListItem - the wishListItem

Returns:

Returns the wishListItem Id of the newly-inserted AdminWishListItem

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteWishListItem

void deleteWishListItem(int wishListItemId)
                 throws KKAdminException

Delete a wishlist and all of its wishlist items.

Parameters:

wishListItemId - the wishListItemId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine