de.hybris.platform.cscockpit.widgets.controllers.impl

Class DefaultReturnsController

java.lang.Object

de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

de.hybris.platform.cscockpit.widgets.controllers.impl.DefaultReturnsController

All Implemented Interfaces:

WidgetController, ReturnsController

public class DefaultReturnsController
extends AbstractCsWidgetController
implements ReturnsController

The default implementation of the ReturnsController interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultReturnsController.RefundDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Long,DefaultReturnsController.RefundDetails>	refundDetailsList
protected OrderModel	refundOrderPreview

Fields inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultReturnsController()

Method Summary

Modifier and Type	Method and Description
protected OrderModel	applyRefunds(OrderModel orderModel, ReturnRequestModel request, Map<Long,DefaultReturnsController.RefundDetails> refundDetailsList, boolean history)
boolean	canReturn() Check if returns are possible for the current order
protected ImpersonationContext	createImpersonationContext(OrderModel order)
TypedObject	createRefundOrderPreview(List<ObjectValueContainer> refundEntriesValueContainers) Create a preview of what the order will look like if the refund entries are removed from the order.
TypedObject	createRefundRequest() Create the refund request.
TypedObject	createReplacementRequest(List<ObjectValueContainer> replacementEntriesValueContainers) Create the replacement request.
void	deleteRefundOrderPreview() delete current refund order preview if present
void	dispatchEvent(String context, Object source, Map<String,Object> data) Notifies all event acceptors which are registered for events with the context code context.
protected void	fixOrderEntryNumbers(OrderModel originalOrder, OrderModel refundOrder)
protected CommonI18NService	getCommonI18NService()
TypedObject	getCurrentOrder() Get the current order
protected ImpersonationService	getImpersonationService()
protected AbstractOrderEntryModel	getOrderEntryByEntryNumber(OrderModel orderModel, long entryNumber)
protected AbstractOrderEntryModel	getOrderEntryByProductAndQty(List<AbstractOrderEntryModel> refundEntriesToFix, ProductModel productModel, long qty)
protected OrderManagementActionsWidgetController	getOrderManagementActionsWidgetController()
protected OrderModel	getOrderModel()
protected PropertyDescriptor	getPropertyDescriptor(Set<PropertyDescriptor> properties, String qualifier)
protected ObjectValueContainer.ObjectValueHolder	getPropertyValue(ObjectValueContainer ovc, String propertyQualifier)
TypedObject	getRefundOrderPreview() Get the current refund order preview.
protected RefundService	getRefundService()
Map<TypedObject,Long>	getReturnableOrderEntries() Get the returnable order entries.
protected ReturnService	getReturnService()
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setImpersonationService(ImpersonationService impersonationService)
void	setOrderManagementActionsWidgetController(OrderManagementActionsWidgetController orderManagementActionsWidgetController)
void	setRefundService(RefundService refundService)
void	setReturnService(ReturnService returnService)
boolean	validateCreateRefundRequest(List<ObjectValueContainer> refundEntriesValueContainers) Validate the return refund request
boolean	validateCreateReplacementRequest(List<ObjectValueContainer> replacementEntriesValueContainers) Validate the return replacement request

Methods inherited from class de.hybris.platform.cscockpit.widgets.controllers.impl.AbstractCsWidgetController

getCockpitTypeService, getModelService, setCockpitTypeService, setModelService

Methods inherited from class de.hybris.platform.cockpit.widgets.controllers.impl.AbstractWidgetController

addCockpitEventAcceptor, dispatchEvent, getAcceptors, removeCockpitEventAcceptor, setCockpitEventAcceptors

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.cockpit.widgets.controllers.WidgetController

addCockpitEventAcceptor, removeCockpitEventAcceptor, setCockpitEventAcceptors

Field Detail

refundDetailsList

protected Map<Long,DefaultReturnsController.RefundDetails> refundDetailsList

refundOrderPreview

protected transient OrderModel refundOrderPreview

Constructor Detail

DefaultReturnsController

public DefaultReturnsController()

Method Detail

getOrderManagementActionsWidgetController

protected OrderManagementActionsWidgetController getOrderManagementActionsWidgetController()

setOrderManagementActionsWidgetController

public void setOrderManagementActionsWidgetController(OrderManagementActionsWidgetController orderManagementActionsWidgetController)

getReturnService

protected ReturnService getReturnService()

setReturnService

public void setReturnService(ReturnService returnService)

getRefundService

protected RefundService getRefundService()

setRefundService

public void setRefundService(RefundService refundService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getImpersonationService

protected ImpersonationService getImpersonationService()

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

getCurrentOrder

public TypedObject getCurrentOrder()

Description copied from interface: ReturnsController

Get the current order

Specified by:

getCurrentOrder in interface ReturnsController

Returns:

the current order

getOrderModel

protected OrderModel getOrderModel()

dispatchEvent

public void dispatchEvent(String context,
                          Object source,
                          Map<String,Object> data)

Description copied from interface: WidgetController

Notifies all event acceptors which are registered for events with the context code context.

Specified by:

dispatchEvent in interface WidgetController

Specified by:

dispatchEvent in class AbstractWidgetController

Parameters:

context - event context

source - event source

data - parameters to be be passed to registered listeners

canReturn

public boolean canReturn()

Description copied from interface: ReturnsController

Check if returns are possible for the current order

Specified by:

canReturn in interface ReturnsController

Returns:

true if returns are possible

getReturnableOrderEntries

public Map<TypedObject,Long> getReturnableOrderEntries()

Description copied from interface: ReturnsController

Get the returnable order entries. Returns a map keyed on the order entry with values of the maximum returnable quantity.

Specified by:

getReturnableOrderEntries in interface ReturnsController

Returns:

the returnable order entries

validateCreateRefundRequest

public boolean validateCreateRefundRequest(List<ObjectValueContainer> refundEntriesValueContainers)
                                    throws ValidationException

Description copied from interface: ReturnsController

Validate the return refund request

Specified by:

validateCreateRefundRequest in interface ReturnsController

Parameters:

refundEntriesValueContainers - the list of return entries

Returns:

true if the return request is valid

Throws:

ValidationException - thrown on validation error

createRefundOrderPreview

public TypedObject createRefundOrderPreview(List<ObjectValueContainer> refundEntriesValueContainers)

Description copied from interface: ReturnsController

Create a preview of what the order will look like if the refund entries are removed from the order. The strategy for calculating the refund value is to create a temporary preview order which is a clone of the original order, remove the items from the order that we except the customer to return, calculate the preview and compare the new total to the original order total. The difference is the amount that would be refunded if these items where actually returned.

Specified by:

createRefundOrderPreview in interface ReturnsController

Parameters:

refundEntriesValueContainers - the list of refund entries

Returns:

an order that has the returned items removed

See Also:

ReturnsController.getRefundOrderPreview()

deleteRefundOrderPreview

public void deleteRefundOrderPreview()

Description copied from interface: ReturnsController

delete current refund order preview if present

Specified by:

deleteRefundOrderPreview in interface ReturnsController

fixOrderEntryNumbers

protected void fixOrderEntryNumbers(OrderModel originalOrder,
                                    OrderModel refundOrder)

getRefundOrderPreview

public TypedObject getRefundOrderPreview()

Description copied from interface: ReturnsController

Get the current refund order preview.

Specified by:

getRefundOrderPreview in interface ReturnsController

Returns:

the refund order preview

See Also:

ReturnsController.createRefundOrderPreview(java.util.List)

applyRefunds

protected OrderModel applyRefunds(OrderModel orderModel,
                                  ReturnRequestModel request,
                                  Map<Long,DefaultReturnsController.RefundDetails> refundDetailsList,
                                  boolean history)

createImpersonationContext

protected ImpersonationContext createImpersonationContext(OrderModel order)

getOrderEntryByEntryNumber

protected AbstractOrderEntryModel getOrderEntryByEntryNumber(OrderModel orderModel,
                                                             long entryNumber)

getOrderEntryByProductAndQty

protected AbstractOrderEntryModel getOrderEntryByProductAndQty(List<AbstractOrderEntryModel> refundEntriesToFix,
                                                               ProductModel productModel,
                                                               long qty)

createRefundRequest

public TypedObject createRefundRequest()

Description copied from interface: ReturnsController

Create the refund request. The refund request uses the details from the previous call to ReturnsController.createRefundOrderPreview(java.util.List<de.hybris.platform.cockpit.services.values.ObjectValueContainer>).

Specified by:

createRefundRequest in interface ReturnsController

Returns:

the return for refund request

validateCreateReplacementRequest

public boolean validateCreateReplacementRequest(List<ObjectValueContainer> replacementEntriesValueContainers)
                                         throws ValidationException

Description copied from interface: ReturnsController

Validate the return replacement request

Specified by:

validateCreateReplacementRequest in interface ReturnsController

Parameters:

replacementEntriesValueContainers - the list of return entries

Returns:

true if the return request is valid

Throws:

ValidationException - thrown on validation error

createReplacementRequest

public TypedObject createReplacementRequest(List<ObjectValueContainer> replacementEntriesValueContainers)

Description copied from interface: ReturnsController

Create the replacement request.

Specified by:

createReplacementRequest in interface ReturnsController

Parameters:

replacementEntriesValueContainers - the list of return entries

Returns:

the return for replacement request

getPropertyValue

protected ObjectValueContainer.ObjectValueHolder getPropertyValue(ObjectValueContainer ovc,
                                                                  String propertyQualifier)

getPropertyDescriptor

protected PropertyDescriptor getPropertyDescriptor(Set<PropertyDescriptor> properties,
                                                   String qualifier)