com.elasticpath.sfweb.viewbean
Interface ProductViewBean

All Superinterfaces:
EpViewBean, java.io.Serializable
All Known Implementing Classes:
ProductViewBeanImpl

public interface ProductViewBean
extends EpViewBean

Represents a bean for product view.


Method Summary
 CatalogViewResult getCurrentCatalogViewResult()
          Returns the current catalog view result.
 Product getProduct()
          Get the product to be displayed.
 int getUpdateCartItemQty()
          Get the Qty of the cart item being updated.
 long getUpdateCartItemUid()
          Get the UID of the cart item being updated.
 java.lang.String getUpdatePage()
          Returns the page that is being updated if isUpdate is true.
 boolean isFromBrowsing()
          Returns true if the product view page is reached from browsing.
 boolean isFromSearch()
          Returns true if the product view page is reached from search.
 boolean isUpdate()
          Returns true if the product is being displayed for updating rather than the initial add to cart.
 void setCurrentCatalogViewResult(CatalogViewResult catalogViewResult)
          Sets the current catalog view result.
 void setProduct(Product product)
          Set the product to be displayed.
 void setUpdateCartItemQty(int updateCartItemQty)
          Set the Qty of the cart item to be updated.
 void setUpdateCartItemUid(long updateCartItemUid)
          Set the UID of the cart item to be updated.
 void setUpdatePage(java.lang.String updatePage)
          Set the page that is being updated.
 
Methods inherited from interface com.elasticpath.sfweb.viewbean.EpViewBean
getElasticPath
 

Method Detail

getCurrentCatalogViewResult

CatalogViewResult getCurrentCatalogViewResult()
Returns the current catalog view result.

Returns:
the current catalog view result

getProduct

Product getProduct()
Get the product to be displayed.

Returns:
the product

getUpdateCartItemQty

int getUpdateCartItemQty()
Get the Qty of the cart item being updated.

Returns:
the Qty of the cart item if a cart item is being updated.

getUpdateCartItemUid

long getUpdateCartItemUid()
Get the UID of the cart item being updated.

Returns:
the UID of the cart item if a cart item is being updated.

getUpdatePage

java.lang.String getUpdatePage()
Returns the page that is being updated if isUpdate is true.

Returns:
a constant String corresponding to the page being updated.

isFromBrowsing

boolean isFromBrowsing()
Returns true if the product view page is reached from browsing.

Returns:
true if the product view page is reached from browsing.

isFromSearch

boolean isFromSearch()
Returns true if the product view page is reached from search.

Returns:
true if the product view page is reached from search.

isUpdate

boolean isUpdate()
Returns true if the product is being displayed for updating rather than the initial add to cart.

Returns:
see above.

setCurrentCatalogViewResult

void setCurrentCatalogViewResult(CatalogViewResult catalogViewResult)
Sets the current catalog view result.

Parameters:
catalogViewResult - the current catalog view result

setProduct

void setProduct(Product product)
Set the product to be displayed.

Parameters:
product - the product

setUpdateCartItemQty

void setUpdateCartItemQty(int updateCartItemQty)
Set the Qty of the cart item to be updated.

Parameters:
updateCartItemQty - the cart item Qty

setUpdateCartItemUid

void setUpdateCartItemUid(long updateCartItemUid)
Set the UID of the cart item to be updated.

Parameters:
updateCartItemUid - the cart item UID

setUpdatePage

void setUpdatePage(java.lang.String updatePage)
Set the page that is being updated. If a product is being updated, this will indicate which page the user should return to upon updating.

Parameters:
updatePage - the page being updated, use a constant in WebConstants