de.hybris.platform.acceleratorfacades.cart.action.impl

Class RemoveCartEntryActionHandler

java.lang.Object

de.hybris.platform.acceleratorfacades.cart.action.impl.RemoveCartEntryActionHandler

All Implemented Interfaces:

CartEntryActionHandler

public class RemoveCartEntryActionHandler
extends java.lang.Object
implements CartEntryActionHandler

CartEntryActionHandler implementation for deleting cart entries.

Constructor Summary

Constructors

Constructor and Description
RemoveCartEntryActionHandler()

Method Summary

Modifier and Type	Method and Description
protected CartFacade	getCartFacade()
java.lang.String	getErrorMessageKey() Provides the key to the message that should be displayed when a CartEntryActionException is thrown.
java.lang.String	getSuccessMessageKey() Provides the key to the message that should be displayed when an action runs with success.
java.util.Optional<java.lang.String>	handleAction(java.util.List<java.lang.Long> entryNumbers) This method contains the logic of the action performed by the CartEntryActionHandler implementation.
void	setCartFacade(CartFacade cartFacade)
boolean	supports(CartEntryModel cartEntry) This method determines if the action should show or not in the cart entry tools menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveCartEntryActionHandler

public RemoveCartEntryActionHandler()

Method Detail

handleAction

public java.util.Optional<java.lang.String> handleAction(java.util.List<java.lang.Long> entryNumbers)
                                                  throws CartEntryActionException

Description copied from interface: CartEntryActionHandler

This method contains the logic of the action performed by the CartEntryActionHandler implementation. Even though the method CartEntryActionHandler.supports(CartEntryModel) prevents unsupported actions to be visible in the contextual menu, it is the responsibility of the handleAction method and the processes it calls to perform appropriate validations in case the action is called on a cart entry for which it should not.

Specified by:

handleAction in interface CartEntryActionHandler

Parameters:

entryNumbers - the cart entry number for which the action is executed.

Returns:

An empty optional to signal the controller to apply the default behaviour: redisplay the cart page with a success message. Otherwise return a custom redirect URL to navigate elsewhere upon the action completion. The expected url format is the format used as SpringMVC controller method return values.

Throws:

CartEntryActionException - when an error occurs.

getSuccessMessageKey

public java.lang.String getSuccessMessageKey()

Description copied from interface: CartEntryActionHandler

Provides the key to the message that should be displayed when an action runs with success.

Specified by:

getSuccessMessageKey in interface CartEntryActionHandler

Returns:

the success message key.

getErrorMessageKey

public java.lang.String getErrorMessageKey()

Description copied from interface: CartEntryActionHandler

Provides the key to the message that should be displayed when a CartEntryActionException is thrown.

Specified by:

getErrorMessageKey in interface CartEntryActionHandler

Returns:

the error message key.

supports

public boolean supports(CartEntryModel cartEntry)

Description copied from interface: CartEntryActionHandler

This method determines if the action should show or not in the cart entry tools menu. An action may not be supported by every cart entry and this is the method to override to make this decision. This method is intended to refine the contents of the contextual menu of a cart item. It is the responsibility of the method and the processes it calls to perform appropriate validations in case the action is called on a cart entry for which it should not.

Specified by:

supports in interface CartEntryActionHandler

Parameters:

cartEntry - the cart entry model.

Returns:

true if the cart entry supports the action, false otherwise.

getCartFacade

protected CartFacade getCartFacade()

setCartFacade

public void setCartFacade(CartFacade cartFacade)