Class DefaultOrderCancelService
java.lang.Object
de.hybris.platform.ordercancel.impl.DefaultOrderCancelService
- All Implemented Interfaces:
OrderCancelCallbackService,OrderCancelService
public class DefaultOrderCancelService
extends Object
implements OrderCancelService, OrderCancelCallbackService
Order Cancel Service implementation
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected OrderModificationRecordEntryModelgetAllCancelableEntries(OrderModel order, PrincipalModel requestor) Returns all cancellableOrderEntry.Gets Cancellation record for a given order.Return current configurationGets cancellation record entry being currently in progress.isCancelPossible(OrderModel order, PrincipalModel requestor, boolean partialCancel, boolean partialEntryCancel) Verifies if order cancel is possible for given order and given conditionsvoidonOrderCancelResponse(OrderCancelResponse cancelResponse) Callback method used by the Warehouse adapter to pass cancel operation result.requestOrderCancel(OrderCancelRequest orderCancelRequest, PrincipalModel requestor) Requests complete cancel operation on an Order.voidsetCancelableEntriesStrategy(OrderCancelCancelableEntriesStrategy cancelableEntriesStrategy) voidsetCancelDenialStrategies(List<OrderCancelDenialStrategy> cancelDenialStrategies) voidsetModelService(ModelService modelService) voidsetOrderCancelDao(OrderCancelDao orderCancelDao) voidsetOrderCancelRecordsHandler(OrderCancelRecordsHandler orderCancelRecordsHandler) voidsetRequestExecutorsMap(Map<OrderCancelState, OrderCancelRequestExecutor> requestExecutorsMap) voidsetResponseExecutorsMap(Map<OrderCancelState, OrderCancelResponseExecutor> responseExecutorsMap) voidsetStateMappingStrategy(OrderCancelStateMappingStrategy stateMappingStrategy)
-
Constructor Details
-
DefaultOrderCancelService
public DefaultOrderCancelService()
-
-
Method Details
-
getCancelRecordForOrder
Description copied from interface:OrderCancelServiceGets Cancellation record for a given order.- Specified by:
getCancelRecordForOrderin interfaceOrderCancelService- Parameters:
order- instance ofOrderModelto get the cancel record for- Returns:
- Cancellation record for the given order
-
getPendingCancelRecordEntry
public OrderCancelRecordEntryModel getPendingCancelRecordEntry(OrderModel order) throws OrderCancelException Description copied from interface:OrderCancelServiceGets cancellation record entry being currently in progress.- Specified by:
getPendingCancelRecordEntryin interfaceOrderCancelService- Parameters:
order- instance ofOrderModelto get the cancel record for- Returns:
- Cancellation record entry being currently in progress.
- Throws:
OrderCancelException- - if more than one entry is being in progress
-
isCancelPossible
public CancelDecision isCancelPossible(OrderModel order, PrincipalModel requestor, boolean partialCancel, boolean partialEntryCancel) Description copied from interface:OrderCancelServiceVerifies if order cancel is possible for given order and given conditions- Specified by:
isCancelPossiblein interfaceOrderCancelService- Parameters:
order- order to be canceled.requestor- instance ofPrincipalModel, containing the principal of a requestorpartialCancel- if true, the methods verifies if partial cancel can be performed on the given orderpartialEntryCancel- if true, the methods verifies if partial entry cancel can be performed on the given order. Partial entry cancel means that only part of order entry is canceled (i.e. only order entry quantity is reduced)- Returns:
- instance of
CancelDecisioncontaining the decision details
-
getAllCancelableEntries
public Map<AbstractOrderEntryModel,Long> getAllCancelableEntries(OrderModel order, PrincipalModel requestor) Returns all cancellableOrderEntry. UsesOrderCancelCancelableEntriesStrategyto perform logic "which entries are cancellable".- Specified by:
getAllCancelableEntriesin interfaceOrderCancelService- Parameters:
order- Order that is subject to cancelrequestor- Principal that originates the request ("issuer of the request"). It might be different from current session user. (can be null)- Returns:
- the cancellable
AbstractOrderEntryModeland their cancellable quantity.
-
getConfiguration
Description copied from interface:OrderCancelServiceReturn current configuration- Specified by:
getConfigurationin interfaceOrderCancelService- Returns:
- current configuration
-
requestOrderCancel
public OrderCancelRecordEntryModel requestOrderCancel(OrderCancelRequest orderCancelRequest, PrincipalModel requestor) throws OrderCancelException Description copied from interface:OrderCancelServiceRequests complete cancel operation on an Order. Depending on current state, order might be canceled immediately or the cancellation decision might be delayed until the response from Warehouse arrives. Returned cancellation record allows to get information about order cancel request.- Specified by:
requestOrderCancelin interfaceOrderCancelService- Parameters:
orderCancelRequest- order cancel request instancerequestor- instance ofPrincipalModel, containing the principal of a requestor- Returns:
- OrderCancelRecordEntryModel that represents the request and the result of cancel operation.
- Throws:
OrderCancelException- in the case the cancellation of order is not allowed
-
onOrderCancelResponse
Description copied from interface:OrderCancelCallbackServiceCallback method used by the Warehouse adapter to pass cancel operation result. Warehouse adapter uses this method to provide feedback information how was the Order canceled (completely, partially, not at all).- Specified by:
onOrderCancelResponsein interfaceOrderCancelCallbackService- Parameters:
cancelResponse- instance ofOrderCancelResponse- Throws:
OrderCancelException- in the case of any error during the order cancellation
-
findPendingCancelRequest
-
getOrderCancelRecordsHandler
- Returns:
- the orderCancelRecordsHandler
-
setOrderCancelRecordsHandler
- Parameters:
orderCancelRecordsHandler- the orderCancelRecordsHandler to set
-
getModelService
- Returns:
- the modelService
-
setModelService
- Parameters:
modelService- the modelService to set
-
getStateMappingStrategy
- Returns:
- the stateMappingStrategy
-
setStateMappingStrategy
- Parameters:
stateMappingStrategy- the stateMappingStrategy to set
-
getCancelDenialStrategies
- Returns:
- the cancelDenialStrategies
-
setCancelDenialStrategies
- Parameters:
cancelDenialStrategies- the cancelDenialStrategies to set
-
getRequestExecutorsMap
- Returns:
- the requestExecutorsMap
-
setRequestExecutorsMap
public void setRequestExecutorsMap(Map<OrderCancelState, OrderCancelRequestExecutor> requestExecutorsMap) - Parameters:
requestExecutorsMap- the requestExecutorsMap to set
-
getResponseExecutorsMap
- Returns:
- the responseExecutorsMap
-
setResponseExecutorsMap
public void setResponseExecutorsMap(Map<OrderCancelState, OrderCancelResponseExecutor> responseExecutorsMap) - Parameters:
responseExecutorsMap- the responseExecutorsMap to set
-
getOrderCancelDao
- Returns:
- the orderCancelDao
-
setOrderCancelDao
- Parameters:
orderCancelDao- the orderCancelDao to set
-
getCancelableEntriesStrategy
- Returns:
- the cancelableEntriesStrategy
-
setCancelableEntriesStrategy
public void setCancelableEntriesStrategy(OrderCancelCancelableEntriesStrategy cancelableEntriesStrategy) - Parameters:
cancelableEntriesStrategy- the cancellableEntriesStrategy to set
-