de.hybris.platform.cscockpit.widgets.controllers

Interface CancellationController

All Superinterfaces:

WidgetController

All Known Implementing Classes:

DefaultCancellationController

public interface CancellationController
extends WidgetController

Interface for the cancellation controller

Method Summary

Modifier and Type	Method and Description
TypedObject	createOrderCancellationRequest(ObjectValueContainer cancelRequest) Create a full order cancel request.
TypedObject	createPartialOrderCancellationRequest(java.util.List<ObjectValueContainer> orderEntryCancelRecords, ObjectValueContainer cancelRequest) Create a partial order cancel request.
java.util.Map<TypedObject,java.lang.Long>	getCancelableOrderEntries() Get all the cancelable order entries.
TypedObject	getOrder() Get the order

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

addCockpitEventAcceptor, dispatchEvent, removeCockpitEventAcceptor, setCockpitEventAcceptors

Method Detail

getOrder

TypedObject getOrder()

Get the order

Returns:

the order

getCancelableOrderEntries

java.util.Map<TypedObject,java.lang.Long> getCancelableOrderEntries()
                                                             throws CancelableOrderDenialReasonsException

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

Returns:

the map of cancelable order entries

Throws:

CancelableOrderDenialReasonsException - thrown if the order is not cancelable

createOrderCancellationRequest

TypedObject createOrderCancellationRequest(ObjectValueContainer cancelRequest)
                                    throws OrderCancelException,
                                           ValidationException

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.

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

createPartialOrderCancellationRequest

TypedObject createPartialOrderCancellationRequest(java.util.List<ObjectValueContainer> orderEntryCancelRecords,
                                                  ObjectValueContainer cancelRequest)
                                           throws OrderCancelException,
                                                  ValidationException

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.

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