ProductDetailController (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- DefaultWidgetController
- - com.hybris.instore.common.impersonation.AbstractImpersonationController
  - - com.hybris.instore.widgets.productdetail.ProductDetailController

public class ProductDetailController
extends AbstractImpersonationController

Widget Controller for productdetails

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMP_ID_BACKBUTTON`
`static String`	`COMP_ID_NEARBYATSGROUPBOX`
`static String`	`COMP_ID_REFRESH_STOCK_BUTTON`
`static String`	`COMP_ID_SIMILAR_BTN`
`static String`	`SETTING_BACK_REQUEST`
`static String`	`SETTING_IMAGE_FORMAT`
`static String`	`SETTING_NEARBY_POS_COUNT`
`static String`	`SETTING_SIMILAR_MAX_COUNT`
`static String`	`SETTING_SIMILAR_PAGE_SIZE`
`static String`	`SOCKET_IN_PRODUCT`
`static String`	`SOCKET_OUT_RELATED_PRODUCTS`

Constructor Summary

Constructors
Constructor and Description

ProductDetailController()

Constructors
Constructor and Description
`ProductDetailController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`availabilityDataLoaded(ProductData product)` Checks if the given `ProductData` has all the availability data.
`protected void`	`clearView()` Reset the view of the widget.
`protected PageableData`	`createPageableData(int page, int size, String sort)` Creates a `PageableData` instance for the product POS stock search.
`void`	`doOnCreate()` onClose_later handler for the nearbyAtsGroupbox component
`void`	`findSimilarProducts()` On click handler for the browseSimilar button.
`protected <any>`	`getLiveAtsStoreFinderStockFacade()` Returns injected liveATSStoreFinderStockFacade `StoreFinderStockFacade`
`protected String`	`getLocalAts(List<PointOfServiceStockData> posStockData)` Returns availability count label for the current store.
`protected List<PointOfServiceStockData>`	`getNearbyPointOfServices(ProductData product, boolean live)` Returns a list of all the point of services (with stock data) considered being nearby the current POS
`protected String`	`getPictureURL(ProductData product)` Get the URL of the image of the preferred format.
`protected String`	`getPOSName()` Returns the current user's default POS.
`protected String`	`getPreferedImageFormat()`
`protected ImageData`	`getPreferredImage(Collection<ImageData> availableImages)` Returns first occurrence if image data that matches the preferred image format.
`protected ProductFacade`	`getProductFacade()` Returns injected `ProductFacade`
`protected ProductData`	`getProductWithAvailabilityOptions(ProductData product)` Returns `ProductData` with populated all availability data.
`protected <any>`	`getStoreFinderStockFacade()` Returns injected storeFinderStockFacade `StoreFinderStockFacade`
`protected String`	`getStoreUid()` Returns the current user's default base store.
`protected String`	`getTotalAtsForPointOfServices(List<PointOfServiceStockData> posStockData)` Returns a string representing the sum of the stock levels of the specified point of services.
`void`	`refreshATS()` On click handler for the refresh ATS button.
`void`	`sendBackRequest()` On click handler for the BACK button.
`void`	`setLiveAtsStoreFinderStockFacade(<any> liveAtsStoreFinderStockFacade)`
`void`	`setProduct(ProductData product)` Displays product in the productDetails controller.
`void`	`setProductFacade(ProductFacade productFacade)`
`void`	`setStoreFinderStockFacade(<any> storeFinderStockFacade)`
`protected void`	`updatePOSData(List<PointOfServiceStockData> nearbyPointOfServices, ProductData product)` Updates the values of current store availability, nearby stores availability and the global availability status flag.
`protected void`	`updateView(ProductData product, boolean liveATS)` Updates the view for the given `ProductData`

Methods inherited from class com.hybris.instore.common.impersonation.AbstractImpersonationController
createImpersonationContext, executeInContext, getCatalogVersionService, getContextCatalogVersions, getContextCurrency, getContextLanguage, getImpersonationService, getInStoreService, getSearchRestrictionService, getSessionService, getUserService, setCatalogVersionService, setImpersonationService, setInStoreService, setSearchRestrictionService, setSessionService, setUserService

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMP_ID_REFRESH_STOCK_BUTTON
```
public static final String COMP_ID_REFRESH_STOCK_BUTTON
```
    See Also:
    
    Constant Field Values
  - COMP_ID_SIMILAR_BTN
```
public static final String COMP_ID_SIMILAR_BTN
```
    See Also:
    
    Constant Field Values
  - COMP_ID_NEARBYATSGROUPBOX
```
public static final String COMP_ID_NEARBYATSGROUPBOX
```
    See Also:
    
    Constant Field Values
  - COMP_ID_BACKBUTTON
```
public static final String COMP_ID_BACKBUTTON
```
    See Also:
    
    Constant Field Values
  - SOCKET_IN_PRODUCT
```
public static final String SOCKET_IN_PRODUCT
```
    See Also:
    
    Constant Field Values
  - SOCKET_OUT_RELATED_PRODUCTS
```
public static final String SOCKET_OUT_RELATED_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SETTING_SIMILAR_PAGE_SIZE
```
public static final String SETTING_SIMILAR_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - SETTING_SIMILAR_MAX_COUNT
```
public static final String SETTING_SIMILAR_MAX_COUNT
```
    See Also:
    
    Constant Field Values
  - SETTING_NEARBY_POS_COUNT
```
public static final String SETTING_NEARBY_POS_COUNT
```
    See Also:
    
    Constant Field Values
  - SETTING_IMAGE_FORMAT
```
public static final String SETTING_IMAGE_FORMAT
```
    See Also:
    
    Constant Field Values
  - SETTING_BACK_REQUEST
```
public static final String SETTING_BACK_REQUEST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProductDetailController
```
public ProductDetailController()
```
- Method Detail
  - setProduct
```
public void setProduct(ProductData product)
```
    Displays product in the productDetails controller. Sets the product data in the widget model and redraws the view.
    
    Parameters:
    
    product -
  - doOnCreate
```
public void doOnCreate()
```
    onClose_later handler for the nearbyAtsGroupbox component
  - updateView
```
protected void updateView(ProductData product,
                          boolean liveATS)
```
    Updates the view for the given ProductData
    
    Parameters:
    
    product -
    
    liveATS - - true if the ATS data for the nearby stores should be updated.
  - updatePOSData
```
protected void updatePOSData(List<PointOfServiceStockData> nearbyPointOfServices,
                             ProductData product)
```
    Updates the values of current store availability, nearby stores availability and the global availability status flag.
    
    Parameters:
    
    nearbyPointOfServices -
    
    product -
  - getProductWithAvailabilityOptions
```
protected ProductData getProductWithAvailabilityOptions(ProductData product)
```
    Returns ProductData with populated all availability data. If availabilityDataLoaded(ProductData) evaluates true for the given product, the same product instance is returned.
    
    Parameters:
    
    product -
    
    Returns:
    
    ProductData
  - availabilityDataLoaded
```
protected boolean availabilityDataLoaded(ProductData product)
```
    Checks if the given ProductData has all the availability data.
    
    Parameters:
    
    product -
    
    Returns:
    
    boolean
  - clearView
```
protected void clearView()
```
    Reset the view of the widget.
  - getPictureURL
```
protected String getPictureURL(ProductData product)
```
    Get the URL of the image of the preferred format. Method tries to get the image data from the given product data. If unsuccessful, it tries to load the gallery images for the product using the ProductFacade call.
    
    Parameters:
    
    product - ProductData
    
    Returns:
    
    String - image URL.
  - getPreferedImageFormat
```
protected String getPreferedImageFormat()
```
    Returns:
    
    string value representing image format that is configured in the widget settings.
  - getPreferredImage
```
protected ImageData getPreferredImage(Collection<ImageData> availableImages)
```
    Returns first occurrence if image data that matches the preferred image format.
    
    Parameters:
    
    availableImages -
    
    Returns:
    
    ImageData or null if availableImages is empty or if no image data from the collection matches preferred image format.
  - findSimilarProducts
```
public void findSimilarProducts()
```
    On click handler for the browseSimilar button. By default, shows products list and populates it with SIMILAR product referenced products.
  - refreshATS
```
public void refreshATS()
```
    On click handler for the refresh ATS button.
  - sendBackRequest
```
public void sendBackRequest()
```
    On click handler for the BACK button.
  - getLocalAts
```
protected String getLocalAts(List<PointOfServiceStockData> posStockData)
```
    Returns availability count label for the current store.
    
    Parameters:
    
    posStockData - - stock data of the nearby stores.
    
    Returns:
    
    String
  - getTotalAtsForPointOfServices
```
protected String getTotalAtsForPointOfServices(List<PointOfServiceStockData> posStockData)
```
    Returns a string representing the sum of the stock levels of the specified point of services.
    
    Parameters:
    
    posStockData - list of point of services (with stock info)
    
    Returns:
    
    the sum of the stock levels across specified point of services or if no stock info could be found
  - getNearbyPointOfServices
```
protected List<PointOfServiceStockData> getNearbyPointOfServices(ProductData product,
                                                                 boolean live)
```
    Returns a list of all the point of services (with stock data) considered being nearby the current POS
    
    Parameters:
    
    product - the product for which stock information is to be loaded
    
    Returns:
    
    all the nearby point of services with stock data for the specified product
    
    See Also:
    
    getPOSName()
  - getStoreUid
```
protected String getStoreUid()
```
    Returns the current user's default base store.
    
    Returns:
    
    the uid of the current user's default base store
  - getPOSName
```
protected String getPOSName()
```
    Returns the current user's default POS.
    
    Returns:
    
    the name of the current user's default point of service
  - createPageableData
```
protected PageableData createPageableData(int page,
                                          int size,
                                          String sort)
```
    Creates a PageableData instance for the product POS stock search.
    
    Parameters:
    
    page -
    
    size -
    
    sort -
    
    Returns:
    
    PageableData
  - getStoreFinderStockFacade
```
protected <any> getStoreFinderStockFacade()
```
    Returns injected storeFinderStockFacade StoreFinderStockFacade
    
    Returns:
    
    StoreFinderStockFacade
  - setStoreFinderStockFacade
```
public void setStoreFinderStockFacade(<any> storeFinderStockFacade)
```
  - getProductFacade
```
protected ProductFacade getProductFacade()
```
    Returns injected ProductFacade
    
    Returns:
    
    ProductFacade
  - setProductFacade
```
public void setProductFacade(ProductFacade productFacade)
```
    Parameters:
    
    productFacade - the productFacade to set
  - getLiveAtsStoreFinderStockFacade
```
protected <any> getLiveAtsStoreFinderStockFacade()
```
    Returns injected liveATSStoreFinderStockFacade StoreFinderStockFacade
    
    Returns:
    
    StoreFinderStockFacade
  - setLiveAtsStoreFinderStockFacade
```
public void setLiveAtsStoreFinderStockFacade(<any> liveAtsStoreFinderStockFacade)
```

Class ProductDetailController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.hybris.instore.common.impersonation.AbstractImpersonationController

Methods inherited from class java.lang.Object

Field Detail

COMP_ID_REFRESH_STOCK_BUTTON

COMP_ID_SIMILAR_BTN

COMP_ID_NEARBYATSGROUPBOX

COMP_ID_BACKBUTTON

SOCKET_IN_PRODUCT

SOCKET_OUT_RELATED_PRODUCTS

SETTING_SIMILAR_PAGE_SIZE

SETTING_SIMILAR_MAX_COUNT

SETTING_NEARBY_POS_COUNT

SETTING_IMAGE_FORMAT

SETTING_BACK_REQUEST

Constructor Detail

ProductDetailController

Method Detail

setProduct

doOnCreate

updateView

updatePOSData

getProductWithAvailabilityOptions

availabilityDataLoaded

clearView

getPictureURL

getPreferedImageFormat

getPreferredImage

findSimilarProducts

refreshATS

sendBackRequest

getLocalAts

getTotalAtsForPointOfServices

getNearbyPointOfServices

getStoreUid

getPOSName

createPageableData

getStoreFinderStockFacade

setStoreFinderStockFacade

getProductFacade

setProductFacade

getLiveAtsStoreFinderStockFacade

setLiveAtsStoreFinderStockFacade