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

Class DefaultCancellationController

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.DefaultCancellationController

All Implemented Interfaces:

WidgetController, CancellationController

public class DefaultCancellationController
extends AbstractCsWidgetController
implements CancellationController

The default implementation of the CancellationController interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultCancellationController.CancelEntryDetails

Field Summary

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

CONTROLLER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DefaultCancellationController()

Method Summary

Modifier and Type	Method and Description
protected OrderCancelRequest	buildCancelRequest(OrderModel order, Map<TypedObject,DefaultCancellationController.CancelEntryDetails> entriesToCancel, ObjectValueContainer cancelRequest)
protected OrderCancelRequest	buildCancelRequest(OrderModel order, ObjectValueContainer cancelRequest)
protected Map<TypedObject,Long>	convert(Map<AbstractOrderEntryModel,Long> cancelableOrderEntries)
TypedObject	createOrderCancellationRequest(ObjectValueContainer cancelRequest) Create a full order cancel request.
TypedObject	createPartialOrderCancellationRequest(List<ObjectValueContainer> orderEntryCancelRecords, ObjectValueContainer cancelRequest) Create a partial order cancel request.
void	dispatchEvent(String context, Object source, Map<String,Object> data) Notifies all event acceptors which are registered for events with the context code context.
Map<TypedObject,Long>	getCancelableOrderEntries() Get all the cancelable order entries.
TypedObject	getOrder() Get the order
protected OrderCancelService	getOrderCancelService()
protected OrderManagementActionsWidgetController	getOrderManagementActionsWidgetController()
protected PropertyDescriptor	getPropertyDescriptor(Set<PropertyDescriptor> properties, String qualifier)
protected ObjectValueContainer.ObjectValueHolder	getPropertyValue(ObjectValueContainer ovc, String propertyQualifier)
protected UserService	getUserService()
void	setOrderCancelService(OrderCancelService orderCancelService)
void	setOrderManagementActionsWidgetController(OrderManagementActionsWidgetController orderManagementActionsWidgetController)
void	setUserService(UserService userService)
protected boolean	validateCreateCancellationRequest(OrderModel orderModel, Map<TypedObject,Long> cancelableOrderEntries, List<ObjectValueContainer> orderEntryCancelRecords)
protected boolean	validateCreateCancellationRequest(OrderModel orderModel, ObjectValueContainer cancelRequest)

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

Constructor Detail

DefaultCancellationController

public DefaultCancellationController()

Method Detail

getOrderManagementActionsWidgetController

protected OrderManagementActionsWidgetController getOrderManagementActionsWidgetController()

setOrderManagementActionsWidgetController

public void setOrderManagementActionsWidgetController(OrderManagementActionsWidgetController orderManagementActionsWidgetController)

getOrderCancelService

protected OrderCancelService getOrderCancelService()

setOrderCancelService

public void setOrderCancelService(OrderCancelService orderCancelService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

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

getOrder

public TypedObject getOrder()

Description copied from interface: CancellationController

Get the order

Specified by:

getOrder in interface CancellationController

Returns:

the order

getCancelableOrderEntries

public Map<TypedObject,Long> getCancelableOrderEntries()
                                                throws CancelableOrderDenialReasonsException

Description copied from interface: CancellationController

Get all the cancelable order entries. Returns a map of order entry to the maximum number of cancelable items.

Specified by:

getCancelableOrderEntries in interface CancellationController

Returns:

the map of cancelable order entries

Throws:

CancelableOrderDenialReasonsException - thrown if the order is not cancelable

convert

protected Map<TypedObject,Long> convert(Map<AbstractOrderEntryModel,Long> cancelableOrderEntries)

buildCancelRequest

protected OrderCancelRequest buildCancelRequest(OrderModel order,
                                                Map<TypedObject,DefaultCancellationController.CancelEntryDetails> entriesToCancel,
                                                ObjectValueContainer cancelRequest)

validateCreateCancellationRequest

protected boolean validateCreateCancellationRequest(OrderModel orderModel,
                                                    Map<TypedObject,Long> cancelableOrderEntries,
                                                    List<ObjectValueContainer> orderEntryCancelRecords)
                                             throws ValidationException

Throws:

ValidationException

getPropertyValue

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

getPropertyDescriptor

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

createPartialOrderCancellationRequest

public TypedObject createPartialOrderCancellationRequest(List<ObjectValueContainer> orderEntryCancelRecords,
                                                         ObjectValueContainer cancelRequest)
                                                  throws OrderCancelException,
                                                         ValidationException

Description copied from interface: CancellationController

Create a partial order cancel request. Request cancellation of some order entries in the order. The list of order entry cancel records identifies how much to cancel from each line. This creates a cancellation request which may be processed synchronously or asynchronously.

Specified by:

createPartialOrderCancellationRequest in interface CancellationController

Parameters:

orderEntryCancelRecords - the quantity and reasons for the cancellation of each line

cancelRequest - the default reasons

Returns:

The OrderCancelRecordEntryModel

Throws:

OrderCancelException - if cancellation fails

ValidationException - if the cancelRequest is invalid

buildCancelRequest

protected OrderCancelRequest buildCancelRequest(OrderModel order,
                                                ObjectValueContainer cancelRequest)

validateCreateCancellationRequest

protected boolean validateCreateCancellationRequest(OrderModel orderModel,
                                                    ObjectValueContainer cancelRequest)
                                             throws ValidationException

Throws:

ValidationException

createOrderCancellationRequest

public TypedObject createOrderCancellationRequest(ObjectValueContainer cancelRequest)
                                           throws OrderCancelException,
                                                  ValidationException

Description copied from interface: CancellationController

Create a full order cancel request. Request cancellation of the whole order (or the remainder or the order). This creates a cancellation request which may be processed synchronously or asynchronously.

Specified by:

createOrderCancellationRequest in interface CancellationController

Parameters:

cancelRequest - The value container holding the values for the properties for the full order cancellation request.

Returns:

The OrderCancelRecordEntryModel

Throws:

OrderCancelException - if cancellation fails

ValidationException - if the cancelRequest is invalid