com.konakart.app

Class AddToWishListOptions

java.lang.Object

com.konakart.app.AddToWishListOptions

All Implemented Interfaces:

AddToWishListOptionsIf

public class AddToWishListOptions
extends java.lang.Object
implements AddToWishListOptionsIf

An object used to contain options used when adding items to the wish list.

Constructor Summary

Constructors

Constructor and Description
AddToWishListOptions() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogId() The id of the catalog which contains dynamic product information such as the price and quantity
int	getCustomerId() If the sessionId is set to null and the customerId is a negative number then the operation is applied to the temporary customer referenced by the negative customer id.
java.util.Calendar	getPriceDate() The date for which a price is requested.
boolean	isGetImages() When getting wish list items we attach a product object to each wish list item.
boolean	isOnlyShowAvailable() When set, the wish list items where quantity desired == quantity received, are not returned in the getWishListItemsWithOptions() API call.
boolean	isUseExternalPrice() If true we attempt to fetch the prices from the external table
void	setCatalogId(java.lang.String catalogId) The id of the catalog which contains dynamic product information such as the price and quantity
void	setCustomerId(int customerId) If the sessionId is set to null and the customerId is a negative number then the operation is applied to the temporary customer referenced by the negative customer id.
void	setGetImages(boolean getImages) When getting wish list items we attach a product object to each wish list item.
void	setOnlyShowAvailable(boolean onlyShowAvailable) When set, the wish list items where quantity desired == quantity received, are not returned in the getWishListItemsWithOptions() API call.
void	setPriceDate(java.util.Calendar priceDate) The date for which a price is requested.
void	setUseExternalPrice(boolean useExternalPrice) If true we attempt to fetch the prices from the external table

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddToWishListOptions

public AddToWishListOptions()

Constructor

Method Detail

getCatalogId

public java.lang.String getCatalogId()

Description copied from interface: AddToWishListOptionsIf

The id of the catalog which contains dynamic product information such as the price and quantity

Specified by:

getCatalogId in interface AddToWishListOptionsIf

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Description copied from interface: AddToWishListOptionsIf

The id of the catalog which contains dynamic product information such as the price and quantity

Specified by:

setCatalogId in interface AddToWishListOptionsIf

Parameters:

catalogId - the catalogId to set

getPriceDate

public java.util.Calendar getPriceDate()

Description copied from interface: AddToWishListOptionsIf

The date for which a price is requested. It could be out in the future.

Specified by:

getPriceDate in interface AddToWishListOptionsIf

Returns:

the priceDate

setPriceDate

public void setPriceDate(java.util.Calendar priceDate)

Description copied from interface: AddToWishListOptionsIf

The date for which a price is requested. It could be out in the future.

Specified by:

setPriceDate in interface AddToWishListOptionsIf

Parameters:

priceDate - the priceDate to set

isOnlyShowAvailable

public boolean isOnlyShowAvailable()

Description copied from interface: AddToWishListOptionsIf

When set, the wish list items where quantity desired == quantity received, are not returned in the getWishListItemsWithOptions() API call.

Specified by:

isOnlyShowAvailable in interface AddToWishListOptionsIf

Returns:

the onlyShowAvailable

setOnlyShowAvailable

public void setOnlyShowAvailable(boolean onlyShowAvailable)

Description copied from interface: AddToWishListOptionsIf

When set, the wish list items where quantity desired == quantity received, are not returned in the getWishListItemsWithOptions() API call.

Specified by:

setOnlyShowAvailable in interface AddToWishListOptionsIf

Parameters:

onlyShowAvailable - the onlyShowAvailable to set

isUseExternalPrice

public boolean isUseExternalPrice()

Description copied from interface: AddToWishListOptionsIf

If true we attempt to fetch the prices from the external table

Specified by:

isUseExternalPrice in interface AddToWishListOptionsIf

Returns:

the useExternalPrice

setUseExternalPrice

public void setUseExternalPrice(boolean useExternalPrice)

Description copied from interface: AddToWishListOptionsIf

If true we attempt to fetch the prices from the external table

Specified by:

setUseExternalPrice in interface AddToWishListOptionsIf

Parameters:

useExternalPrice - the useExternalPrice to set

getCustomerId

public int getCustomerId()

Description copied from interface: AddToWishListOptionsIf

If the sessionId is set to null and the customerId is a negative number then the operation is applied to the temporary customer referenced by the negative customer id.

Specified by:

getCustomerId in interface AddToWishListOptionsIf

Returns:

the customerId

setCustomerId

public void setCustomerId(int customerId)

Description copied from interface: AddToWishListOptionsIf

If the sessionId is set to null and the customerId is a negative number then the operation is applied to the temporary customer referenced by the negative customer id.

Specified by:

setCustomerId in interface AddToWishListOptionsIf

Parameters:

customerId - the customerId to set

isGetImages

public boolean isGetImages()

When getting wish list items we attach a product object to each wish list item. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

isGetImages in interface AddToWishListOptionsIf

Returns:

the getImages

setGetImages

public void setGetImages(boolean getImages)

When getting wish list items we attach a product object to each wish list item. If getImages is set to true, we attach a ProductImages object to the product, which contains a list of image names available for it.

Specified by:

setGetImages in interface AddToWishListOptionsIf

Parameters:

getImages - the getImages to set