com.konakart.blif

Interface WishListMgrIf

All Known Implementing Classes:

WishListMgr

public interface WishListMgrIf

WishListMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
int	addToWishList(java.lang.String sessionId, WishListItemIf wishListItem) Add a WishListItem object to the wish list referenced by wishListId.
int	addToWishListWithOptions(java.lang.String sessionId, WishListItemIf wishListItem, AddToWishListOptionsIf options) Add a WishListItem object to the wish list referenced by wishListId.
int	createWishList(java.lang.String sessionId, WishListIf wishList) Create a wish list from a WishList object.
int	createWishListWithOptions(java.lang.String sessionId, WishListIf wishList, AddToWishListOptionsIf options) Create a wish list from a WishList object.
void	deleteWishList(java.lang.String sessionId, int wishListId) The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted.
void	deleteWishListWithOptions(java.lang.String sessionId, int wishListId, AddToWishListOptionsIf options) The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted.
void	editWishList(java.lang.String sessionId, WishListIf wishList) Edit an existing wish list object.
void	editWishListWithOptions(java.lang.String sessionId, WishListIf wishList, AddToWishListOptionsIf options) Edit an existing wish list object.
WishList	getWishList(int wishListId) Get a wish list object for its id.
WishList	getWishList(java.lang.String sessionId, int wishListId) Get a wish list object for its id.
WishListItems	getWishListItems(java.lang.String sessionId, DataDescriptorIf dataDesc, int wishListId, int languageId) Returns a WishListItems object containing an array of items and the number of items returned.
WishListItems	getWishListItemsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int wishListId, int languageId, AddToWishListOptionsIf options) Returns a WishListItems object containing an array of items and the number of items returned.
WishList	getWishListWithItems(java.lang.String sessionId, int wishListId, int languageId) Returns a fully populated WishList object that may contain an array of WishListItem objects.
WishList	getWishListWithItemsWithOptions(java.lang.String sessionId, int wishListId, int languageId, AddToWishListOptionsIf options) Returns a fully populated WishList object that may contain an array of WishListItem objects.
WishList	getWishListWithOptions(java.lang.String sessionId, int wishListId, AddToWishListOptionsIf options) Get a wish list object for its id.
void	mergeWishListsWithOptions(java.lang.String sessionId, int customerFromId, int languageId, AddToWishListOptionsIf wishListOptions) Add all items from the wish list of customerFrom to the wish list of customerTo which is retrieved from the sessionId.
void	removeFromWishList(java.lang.String sessionId, int wishListItemId) Remove the WishListItem object referenced by wishListItemId.
void	removeFromWishListWithOptions(java.lang.String sessionId, int wishListItemId, AddToWishListOptionsIf options) Remove the WishListItem object referenced by wishListItemId.
WishLists	searchForWishLists(java.lang.String sessionId, DataDescriptorIf dataDescriptor, CustomerSearchIf customerSearch) All wish lists matching the search criteria will be returned.
void	updateWishListItemQuantityBought(int wishListItemId, int quantityBought) Updates the wishListItem quantity received attribute by adding quantityBought to the actual value.

Method Detail

createWishList

int createWishList(java.lang.String sessionId,
                   WishListIf wishList)
            throws java.lang.Exception

Create a wish list from a WishList object. Once created, the method getWishListWithItems() can be called to add wish list items to the wish list. The compulsory attributes for the WishListItem are:

• publicWishList

Parameters:

sessionId - the sessionId

wishList - the wishList

Returns:

Returns the id of the new WishList object

Throws:

java.lang.Exception - an unexpected exception

createWishListWithOptions

int createWishListWithOptions(java.lang.String sessionId,
                              WishListIf wishList,
                              AddToWishListOptionsIf options)
                       throws java.lang.Exception

Create a wish list from a WishList object. Once created, the method getWishListWithItems() can be called to add wish list items to the wish list. This method may be called even when a customer isn't logged in. In this case the customerId attribute of the options object must be set to the id of the temporary customer which is negative. The compulsory attributes for the WishListItem are:

• publicWishList

Parameters:

sessionId - the sessionId

wishList - the wishList

options - the options

Returns:

Returns the id of the new WishList object

Throws:

java.lang.Exception - an unexpected exception

editWishList

void editWishList(java.lang.String sessionId,
                  WishListIf wishList)
           throws java.lang.Exception

Edit an existing wish list object. A check is made that the wish list actually belongs to the user referenced by the session id.

Parameters:

sessionId - The session id of the logged in user

wishList - The wish list to be edited

Throws:

java.lang.Exception - an unexpected exception

editWishListWithOptions

void editWishListWithOptions(java.lang.String sessionId,
                             WishListIf wishList,
                             AddToWishListOptionsIf options)
                      throws java.lang.Exception

Edit an existing wish list object. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. A check is made that the wish list actually belongs to the user referenced by the session id or customer id.

Parameters:

sessionId - The session id of the logged in user

wishList - The wish list to be edited

options - the options

Throws:

java.lang.Exception - an unexpected exception

addToWishList

int addToWishList(java.lang.String sessionId,
                  WishListItemIf wishListItem)
           throws java.lang.Exception

Add a WishListItem object to the wish list referenced by wishListId. If the wish list doesn't belong to the logged in customer, an exception is thrown. If the WishListItem already exists, then it is updated.
The compulsory attributes for the WishListItem are:

• productId
• wishListId

The WishListItem may also contain an array of options if these are applicable for the chosen product.

Parameters:

sessionId - the sessionId

wishListItem - the wishListItem

Returns:

Returns the id of the new wishListItem object

Throws:

java.lang.Exception - an unexpected exception

addToWishListWithOptions

int addToWishListWithOptions(java.lang.String sessionId,
                             WishListItemIf wishListItem,
                             AddToWishListOptionsIf options)
                      throws java.lang.Exception

Add a WishListItem object to the wish list referenced by wishListId. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. If the wish list doesn't belong to the logged in customer or the customer referenced by the customer id, an exception is thrown. If the WishListItem already exists, then it is updated.
The compulsory attributes for the WishListItem are:

• productId
• wishListId

The WishListItem may also contain an array of options if these are applicable for the chosen product. If options is set to null, this method is identical to addToWishList(). Otherwise the functionality differs depending on the combination of options set.

Parameters:

sessionId - the sessionId

wishListItem - the wishListItem

options - the options

Returns:

Returns the id of the new wishListItem object

Throws:

java.lang.Exception - an unexpected exception

removeFromWishList

void removeFromWishList(java.lang.String sessionId,
                        int wishListItemId)
                 throws java.lang.Exception

Remove the WishListItem object referenced by wishListItemId. The WishListItem will only be deleted if the wish list belongs to the logged in customer. If the wish list does not belong to the customer referenced by the sessionId, an exception will be thrown.

Parameters:

sessionId - the sessionId

wishListItemId - the wishListItemId

Throws:

java.lang.Exception - an unexpected exception

removeFromWishListWithOptions

void removeFromWishListWithOptions(java.lang.String sessionId,
                                   int wishListItemId,
                                   AddToWishListOptionsIf options)
                            throws java.lang.Exception

Remove the WishListItem object referenced by wishListItemId. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. The WishListItem will only be deleted if the wish list belongs to the logged in customer or the customer referenced by the customer id. If the wish list does not belong to the customer referenced by the sessionId or customer id, an exception will be thrown.

Parameters:

sessionId - the sessionId

wishListItemId - the wishListItemId

options - the options

Throws:

java.lang.Exception - an unexpected exception

deleteWishList

void deleteWishList(java.lang.String sessionId,
                    int wishListId)
             throws java.lang.Exception

The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted. An exception will be thrown if the wish list does not belong to the logged in customer.

Parameters:

sessionId - the sessionId

wishListId - the wishListId

Throws:

java.lang.Exception - an unexpected exception

deleteWishListWithOptions

void deleteWishListWithOptions(java.lang.String sessionId,
                               int wishListId,
                               AddToWishListOptionsIf options)
                        throws java.lang.Exception

The wish list referenced by wishListId and all of the items contained by the wish list, will be deleted. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. The WishListItem will only be deleted if the wish list belongs to the logged in customer or the customer referenced by the customer id. An exception will be thrown if the wish list does not belong to the logged in customer or customer referenced by customerId.

Parameters:

sessionId - the sessionId

wishListId - the wishListId

options - the options

Throws:

java.lang.Exception - an unexpected exception

searchForWishLists

WishLists searchForWishLists(java.lang.String sessionId,
                             DataDescriptorIf dataDescriptor,
                             CustomerSearchIf customerSearch)
                      throws java.lang.Exception

All wish lists matching the search criteria will be returned. They will be grouped by customerId. Note that in order to retrieve the wish list items, you must call the getWishListWithItems() method, passing it the id of the wish list. This will also populate the final price attributes of the wish list.
If customerSearch is null, then only the wish lists of the logged in customer will be returned. If dataDesc is set to null, a default DataDescriptor will be used.
Only the following attributes of the CustomerSearchIf object will be used:

• tmpId - to find wish lists for non logged in customers that have a negative customer id. Will only be used if set to a negative number.
• firstName - to find wish lists for all customers with this first name
• lastName - to find wish lists for all customers with this last name
• firstName1 - to find wish lists for all 2nd customers with this first name. i.e. Wedding list
• lastName1 - to find wish lists for all 2nd customers with this last name. i.e. Wedding list
• city - to find wish lists for all customers living in this city
• state - to find wish lists for all customers living in this state
• cityOrState - to find wish lists for all customers living in this city or state
• eventDate - to find wish lists for events such as wedding lists or birthday lists
• type - type of WishList. Ignored when set to a negative number. If not negative it will match the listType attribute of the Wish List

The custom fields of the dataDesc object will also be used in the search if not set to null.

Parameters:

sessionId - The session id of the logged in user. It may be null if the user isn't logged in.

dataDescriptor - the dataDescriptor

customerSearch - the customerSearch

Returns:

Returns a WishListsIf object containing an array of wishList objects and paging information.

Throws:

java.lang.Exception - an unexpected exception

getWishListWithItems

WishList getWishListWithItems(java.lang.String sessionId,
                              int wishListId,
                              int languageId)
                       throws java.lang.Exception

Returns a fully populated WishList object that may contain an array of WishListItem objects. An exception will be thrown if the wish list doesn't belong to the logged in customer and is private.
Each WishListItem object will have a populated product attribute and populated opts attribute if the WishListItem contains options. The items will be ordered by priority with the highest priority first.

Parameters:

sessionId - The session id of the logged in user. It may be null if the user isn't logged in.

wishListId - the wishListId

languageId - the languageId

Returns:

Returns a WishList object that contains an array of WishListItem objects

Throws:

java.lang.Exception - an unexpected exception

getWishListWithItemsWithOptions

WishList getWishListWithItemsWithOptions(java.lang.String sessionId,
                                         int wishListId,
                                         int languageId,
                                         AddToWishListOptionsIf options)
                                  throws java.lang.Exception

Returns a fully populated WishList object that may contain an array of WishListItem objects. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. An exception will be thrown if the wish list doesn't belong to the logged in customer or customer referenced by customer id, and is private.
Each WishListItem object will have a populated product attribute and populated opts attribute if the WishListItem contains options. The items will be ordered by priority with the highest priority first. If options is set to null, this method is identical to getWishListWithItems(). Otherwise the functionality differs depending on the combination of options set.

Parameters:

sessionId - The session id of the logged in user. It may be null if the user isn't logged in.

wishListId - the wishListId

languageId - the languageId

options - the options

Returns:

Returns an array of WishListItem objects

Throws:

java.lang.Exception - an unexpected exception

getWishList

WishList getWishList(java.lang.String sessionId,
                     int wishListId)
              throws java.lang.Exception

Get a wish list object for its id. The items are not populated. An exception is thrown if the wish list doesn't belong to the logged in customer and is private. Null is returned if the wish list doesn't exist.

Parameters:

sessionId - the sessionId

wishListId - the wishListId

Returns:

Return a WishList object

Throws:

java.lang.Exception - an unexpected exception

getWishListWithOptions

WishList getWishListWithOptions(java.lang.String sessionId,
                                int wishListId,
                                AddToWishListOptionsIf options)
                         throws java.lang.Exception

Get a wish list object for its id. The items are not populated. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. An exception will be thrown if the wish list doesn't belong to the logged in customer or customer referenced by customer id, and is private. Null is returned if the wish list doesn't exist.

Parameters:

sessionId - the sessionId

wishListId - the wishListId

options - the options

Returns:

Return a WishList object

Throws:

java.lang.Exception - an unexpected exception

getWishList

WishList getWishList(int wishListId)
              throws org.apache.torque.TorqueException,
                     com.workingdogs.village.DataSetException

Get a wish list object for its id. The items are not populated. Null is returned if the wish list doesn't exist.

Parameters:

wishListId - the wishListId

Returns:

Return a WishList object

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)

updateWishListItemQuantityBought

void updateWishListItemQuantityBought(int wishListItemId,
                                      int quantityBought)
                               throws java.lang.Exception

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

Parameters:

wishListItemId - the wishListItemId

quantityBought - the quantityBought

Throws:

java.lang.Exception - an unexpected exception

getWishListItemsWithOptions

WishListItems getWishListItemsWithOptions(java.lang.String sessionId,
                                          DataDescriptorIf dataDesc,
                                          int wishListId,
                                          int languageId,
                                          AddToWishListOptionsIf options)
                                   throws java.lang.Exception

Returns a WishListItems object containing an array of items and the number of items returned. The DataDescriptor object can be user to sort and page the returned items. The sessionId may be left null if a temporary customer id (negative number) is added to the options object. An exception will be thrown if the wish list doesn't belong to the logged in customer or customer referenced by customer id, and is private.
However, by setting the attributes of dataDesc, the following functionality may be controlled :

• The maximum number of wish list item objects returned.
• The offset which defaults to zero. This is useful when there are many wish list item objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only wish list items with a matching custom attribute value are returned.
• The wish list item may be sorted by :
  • Priority Ascending / Descending
  • Custom1 Ascending / Descending
  • Custom2 Ascending / Descending
  • Custom3 Ascending / Descending
  • Custom4 Ascending / Descending
  • Custom5 Ascending / Descending

If the onlyShowAvailable attribute of the options object is set, then the wish list items that have quantity received equal to quantity desired, are not returned.

Parameters:

sessionId - The session id of the logged in user. It may be null if the user isn't logged in.

dataDesc - the dataDesc

wishListId - the wishListId

languageId - the languageId

options - the options

Returns:

Returns a WishListItems objects

Throws:

java.lang.Exception - an unexpected exception

getWishListItems

WishListItems getWishListItems(java.lang.String sessionId,
                               DataDescriptorIf dataDesc,
                               int wishListId,
                               int languageId)
                        throws java.lang.Exception

Returns a WishListItems object containing an array of items and the number of items returned. The DataDescriptor object can be user to sort and page the returned items. An exception will be thrown if the wish list doesn't belong to the logged in customer and is private.
However, by setting the attributes of dataDesc, the following functionality may be controlled :

• The maximum number of wish list item objects returned.
• The offset which defaults to zero. This is useful when there are many wish list item objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only wish list items with a matching custom attribute value are returned.
• The wish list item may be sorted by :
  • Priority Ascending / Descending
  • Custom1 Ascending / Descending
  • Custom2 Ascending / Descending
  • Custom3 Ascending / Descending
  • Custom4 Ascending / Descending
  • Custom5 Ascending / Descending

Parameters:

sessionId - The session id of the logged in user. It may be null if the user isn't logged in.

dataDesc - the dataDesc

wishListId - the wishListId

languageId - the languageId

Returns:

Returns a WishListItems objects

Throws:

java.lang.Exception - an unexpected exception

mergeWishListsWithOptions

void mergeWishListsWithOptions(java.lang.String sessionId,
                               int customerFromId,
                               int languageId,
                               AddToWishListOptionsIf wishListOptions)
                        throws java.lang.Exception

Add all items from the wish list of customerFrom to the wish list of customerTo which is retrieved from the sessionId. This is done when a customer logs in, to move his temporary wish list to his permanent wish list.

The currently logged in customer may have more than one wish list. The one used is the first one found of listType == 0.

Parameters:

sessionId - the sessionId

customerFromId - the customerFromId

languageId - the languageId

wishListOptions - the wishListOptions

Throws:

java.lang.Exception - an unexpected exception