Package de.hybris.platform.orderselfserviceaddon.controllers.pages

Class ReturnOrderPageController

java.lang.Object

de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

de.hybris.platform.orderselfserviceaddon.controllers.pages.ReturnOrderPageController

@Controller
@RequestMapping("/my-account/order")
public class ReturnOrderPageController
extends AbstractSearchPageController

Controller for return order pages

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

AbstractSearchPageController.SearchResultsData<RESULT>, AbstractSearchPageController.ShowMode

Nested classes/interfaces inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

AbstractController.HttpNotFoundException

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BREADCRUMBS_ATTR
static org.slf4j.Logger	LOG
static java.lang.String	MY_ACCOUNT_ORDER
static java.lang.String	MY_ACCOUNT_ORDERS
static java.lang.String	MY_ACCOUNT_RETURNS
static java.lang.String	REDIRECT_TO_ORDERS_HISTORY_PAGE
static java.lang.String	RETRUN_CONFIRM_ORDER_CMS_PAGE
static java.lang.String	RETURN_ORDER_CMS_PAGE

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

MAX_PAGE_LIMIT

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

CMS_PAGE_MODEL, CMS_PAGE_TITLE, PAGE_ROOT, REDIRECT_TO_LOGIN_FOR_CHECKOUT, REDIRECT_TO_MULTISTEP_CHECKOUT, REGISTRATION_CONSENT_ID, UTF_8

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

FORWARD_PREFIX, REDIRECT_PREFIX, ROOT

Constructor Summary

Constructors

Constructor	Description
ReturnOrderPageController()

Method Summary

Modifier and Type	Method	Description
java.lang.String	confirmReturnOrderPage(java.lang.String orderCode, OrderEntryReturnForm orderEntryReturnForm, org.springframework.ui.Model model, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)
protected OrderEntryReturnForm	initializeForm(OrderData orderData)	Initialize the input form and takes care of the multiD case
protected boolean	isMultiD(OrderEntryData orderEntryData)	A method that checks if the product associated with this orderEntry is a multi dimensional product
protected boolean	isMultidimensionalEntry(OrderEntryData orderEntry)	Confirms if the given OrderEntryData is for multidimensional product
protected void	populateMapForNestedEntries(java.util.Map<java.lang.Integer,java.lang.Long> returnEntryQuantityMap, OrderEntryData orderEntryData)
protected ReturnRequestData	prepareReturnRequestData(OrderData order, OrderEntryReturnForm orderEntryReturnForm)	It prepares the ReturnRequestData object by taking the order and the map of orderentries OrderEntryData number and returned quantities
protected java.lang.String	redirectToOrdersHistory(org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)	Redirects the flow to the Orders History page and notifies the user with the RedirectAttributes.
protected void	setReturnedItemsPrice(java.lang.Long qty, OrderEntryData orderEntryData)	Updates the OrderEntryData.returnedItemsPrice for the given requested return quantity
java.lang.String	showReturnOrderPage(java.lang.String orderCode, org.springframework.ui.Model model, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)
java.lang.String	submitCancelOrderPage(java.lang.String orderCode, OrderEntryReturnForm orderEntryReturnForm, org.springframework.ui.Model model, org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

calculateShowAll, calculateShowPaged, convertBreadcrumbsToFacets, createEmptyPagination, createPageableData, encodeSearchPageData, existsFacetValueWithName, getMaxSearchPageSize, getSearchPageSize, isShowAllAllowed, populateModel, processFacetData, processFacetDatas, refineFacets

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

addRegistrationConsentDataToModel, checkRequestUrl, createMetaElement, decodeWithScheme, getBaseSiteService, getCheckoutRedirectUrl, getCmsPageService, getCmsPreviewService, getCmsSiteService, getConfigurationService, getConsentFacade, getContentPageForLabelOrId, getCurrencies, getCurrentCurrency, getCurrentLanguage, getCustomerFacade, getHostConfigService, getI18nService, getLanguages, getMessageSource, getPageTitleResolver, getRequestContextData, getSessionService, getSiteConfigService, getSiteName, getSiteUid, getStoreSessionFacade, getUser, getUserFacade, getViewForPage, getViewForPage, prepareNotFoundPage, setUpMetaData, setUpMetaDataForContentPage, storeCmsPageInModel, storeContentPageTitleInModel, storeContinueUrl, urlEncode

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

addRequestToModel, getBean

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

BREADCRUMBS_ATTR

public static final java.lang.String BREADCRUMBS_ATTR

See Also:

Constant Field Values

MY_ACCOUNT_ORDERS

public static final java.lang.String MY_ACCOUNT_ORDERS

See Also:

Constant Field Values

REDIRECT_TO_ORDERS_HISTORY_PAGE

public static final java.lang.String REDIRECT_TO_ORDERS_HISTORY_PAGE

See Also:

Constant Field Values

RETURN_ORDER_CMS_PAGE

public static final java.lang.String RETURN_ORDER_CMS_PAGE

See Also:

Constant Field Values

RETRUN_CONFIRM_ORDER_CMS_PAGE

public static final java.lang.String RETRUN_CONFIRM_ORDER_CMS_PAGE

See Also:

Constant Field Values

MY_ACCOUNT_ORDER

public static final java.lang.String MY_ACCOUNT_ORDER

See Also:

Constant Field Values

MY_ACCOUNT_RETURNS

public static final java.lang.String MY_ACCOUNT_RETURNS

See Also:

Constant Field Values

Constructor Detail

ReturnOrderPageController

public ReturnOrderPageController()

Method Detail

showReturnOrderPage

@RequestMapping(value="/{orderCode:.*}/returns",
                method={POST,GET})
public java.lang.String showReturnOrderPage(@PathVariable("orderCode")
                                            java.lang.String orderCode,
                                            org.springframework.ui.Model model,
                                            org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)
                                     throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

confirmReturnOrderPage

@RequestMapping(value="/{orderCode:.*}/returns/confirm",
                method=POST)
public java.lang.String confirmReturnOrderPage(@PathVariable("orderCode")
                                               java.lang.String orderCode,
                                               @ModelAttribute("orderEntryReturnForm")
                                               OrderEntryReturnForm orderEntryReturnForm,
                                               org.springframework.ui.Model model,
                                               org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)
                                        throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

submitCancelOrderPage

@RequestMapping(value="/{orderCode:.*}/returns/submit",
                method=POST)
public java.lang.String submitCancelOrderPage(@PathVariable("orderCode")
                                              java.lang.String orderCode,
                                              @ModelAttribute("orderEntryCancelForm")
                                              OrderEntryReturnForm orderEntryReturnForm,
                                              org.springframework.ui.Model model,
                                              org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)
                                       throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

prepareReturnRequestData

protected ReturnRequestData prepareReturnRequestData(OrderData order,
                                                     OrderEntryReturnForm orderEntryReturnForm)

It prepares the ReturnRequestData object by taking the order and the map of orderentries OrderEntryData number and returned quantities

Parameters:

order - order OrderData which we want to return

orderEntryReturnForm - a OrderEntryReturnForm map of orderentries number and the returned quantities

Returns:

returnRequest ReturnRequestData

isMultidimensionalEntry

protected boolean isMultidimensionalEntry(OrderEntryData orderEntry)

Confirms if the given OrderEntryData is for multidimensional product

Parameters:

orderEntry - the given OrderEntryData

Returns:

true, if the given OrderEntryData is for multidimensional product

initializeForm

protected OrderEntryReturnForm initializeForm(OrderData orderData)

Initialize the input form and takes care of the multiD case

Parameters:

orderData - The given orderOrderData to be returned

Returns:

initialized form OrderEntryReturnForm with initial values of 0

populateMapForNestedEntries

protected void populateMapForNestedEntries(java.util.Map<java.lang.Integer,java.lang.Long> returnEntryQuantityMap,
                                           OrderEntryData orderEntryData)

Parameters:

returnEntryQuantityMap - The map to populate with entry number and quantity to return

orderEntryData - The order entry OrderEntryData that holds a MultiD product

isMultiD

protected boolean isMultiD(OrderEntryData orderEntryData)

A method that checks if the product associated with this orderEntry is a multi dimensional product

Parameters:

orderEntryData - the order entry OrderEntryData

Returns:

true if the product in the orderEntryData is multiD and false if it is not set or it is not.

setReturnedItemsPrice

protected void setReturnedItemsPrice(java.lang.Long qty,
                                     OrderEntryData orderEntryData)

Updates the OrderEntryData.returnedItemsPrice for the given requested return quantity

Parameters:

qty - the quantity to be returned from the given OrderEntryData

orderEntryData - the OrderEntryData

redirectToOrdersHistory

protected java.lang.String redirectToOrdersHistory(org.springframework.web.servlet.mvc.support.RedirectAttributes redirectModel)

Redirects the flow to the Orders History page and notifies the user with the RedirectAttributes.

Parameters:

redirectModel - the RedirectAttributes used to display a message to the user

Returns:

View String