de.hybris.platform.cscockpit.widgets.controllers

Interface ReturnsController

All Superinterfaces:

WidgetController

All Known Implementing Classes:

DefaultReturnsController

public interface ReturnsController
extends WidgetController

Interface for the returns controller

Method Summary

Modifier and Type	Method and Description
boolean	canReturn() Check if returns are possible for the current 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> returnEntriesValueContainers) Create the replacement request.
void	deleteRefundOrderPreview() delete current refund order preview if present
TypedObject	getCurrentOrder() Get the current order
TypedObject	getRefundOrderPreview() Get the current refund order preview.
Map<TypedObject,Long>	getReturnableOrderEntries() Get the returnable order entries.
boolean	validateCreateRefundRequest(List<ObjectValueContainer> returnEntriesValueContainers) Validate the return refund request
boolean	validateCreateReplacementRequest(List<ObjectValueContainer> returnEntriesValueContainers) Validate the return replacement request

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

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

canReturn

boolean canReturn()

Check if returns are possible for the current order

Returns:

true if returns are possible

getReturnableOrderEntries

Map<TypedObject,Long> getReturnableOrderEntries()

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

Returns:

the returnable order entries

getCurrentOrder

TypedObject getCurrentOrder()

Get the current order

Returns:

the current order

validateCreateRefundRequest

boolean validateCreateRefundRequest(List<ObjectValueContainer> returnEntriesValueContainers)
                             throws ValidationException

Validate the return refund request

Parameters:

returnEntriesValueContainers - the list of return entries

Returns:

true if the return request is valid

Throws:

ValidationException - thrown on validation error

validateCreateReplacementRequest

boolean validateCreateReplacementRequest(List<ObjectValueContainer> returnEntriesValueContainers)
                                  throws ValidationException

Validate the return replacement request

Parameters:

returnEntriesValueContainers - the list of return entries

Returns:

true if the return request is valid

Throws:

ValidationException - thrown on validation error

createRefundOrderPreview

TypedObject createRefundOrderPreview(List<ObjectValueContainer> refundEntriesValueContainers)

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.

Parameters:

refundEntriesValueContainers - the list of refund entries

Returns:

an order that has the returned items removed

See Also:

getRefundOrderPreview()

deleteRefundOrderPreview

void deleteRefundOrderPreview()

delete current refund order preview if present

getRefundOrderPreview

TypedObject getRefundOrderPreview()

Get the current refund order preview.

Returns:

the refund order preview

See Also:

createRefundOrderPreview(java.util.List)

createRefundRequest

TypedObject createRefundRequest()

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

Returns:

the return for refund request

createReplacementRequest

TypedObject createReplacementRequest(List<ObjectValueContainer> returnEntriesValueContainers)

Create the replacement request.

Parameters:

returnEntriesValueContainers - the list of return entries

Returns:

the return for replacement request