Package de.hybris.platform.ordermanagementfacades.returns.impl

Class DefaultOmsReturnFacade

java.lang.Object

de.hybris.platform.ordermanagementfacades.OmsBaseFacade

de.hybris.platform.ordermanagementfacades.returns.impl.DefaultOmsReturnFacade

All Implemented Interfaces:

OmsReturnFacade

public class DefaultOmsReturnFacade
extends OmsBaseFacade
implements OmsReturnFacade

Order management default Return Facade implementation for the OmsReturnFacade

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
DefaultOmsReturnFacade()

Method Summary

Modifier and Type	Method	Description
void	approveReturnRequest(java.lang.String code)	API to approve the ReturnRequestModel by its code
protected java.math.BigDecimal	calculateRefundEntryAmount(AbstractOrderEntryModel orderEntryModel, java.lang.Long expectedQuantity, boolean completeReturn)	Evaluates refundAmount for the RefundEntryModel to be created.
void	cancelReturnRequest(CancelReturnRequestData cancelReturnRequestData)	API to cancel a ReturnRequestModel
protected java.lang.Boolean	canRefundDeliveryCost(java.lang.String orderCode, java.lang.Boolean isDeliveryCostRequested)	Evaluates if deliveryCost should be refunded for the requested ReturnRequestModel to be created
ReturnRequestData	createReturnRequest(ReturnRequestData returnRequestData)	API to create a ReturnRequestModel
protected ReturnRequestModel	createReturnRequestInContext(OrderModel order, ReturnRequestData returnRequestData)	Creates ReturnRequestModel in the ImpersonationContext
protected void	evaluateResultList(ReturnEntryModificationData entry, java.util.List<ReturnEntryModel> resultList)	Verifies that the list is neither missing or duplicated and sets the RefundEntryModel.AMOUNT with the ReturnEntryModificationData.refundAmount
protected BaseStoreService	getBaseStoreService()
java.util.List<CancelReason>	getCancelReasons()	API to get all return cancel reasons
protected CustomerAccountService	getCustomerAccountService()
protected EnumerationService	getEnumerationService()
protected EventService	getEventService()
protected ImpersonationService	getImpersonationService()
protected java.util.Set<ReturnStatus>	getInvalidReturnStatusForRefundDeliveryCost()
protected OrderService	getOrderService()
SearchPageData<ReturnRequestData>	getPagedReturnRequestsByCurrentUser(PageableData pageableData, ReturnStatus... returnStatuses)	Returns the paged ReturnRequestData for the current user.
java.util.List<RefundReason>	getRefundReasons()	API to get all return refund reasons
protected RefundService	getRefundService()
java.util.List<ReturnAction>	getReturnActions()	API to get all return actions
protected ReturnCallbackService	getReturnCallbackService()
protected Converter<ReturnRequestModel,ReturnRequestData>	getReturnConverter()
SearchPageData<ReturnEntryData>	getReturnEntriesForReturnCode(java.lang.String code, PageableData pageableData)	API to get returnEntries for the given ReturnRequestModel.CODE
protected Converter<ReturnEntryModel,ReturnEntryData>	getReturnEntryConverter()
protected PagedGenericDao<ReturnEntryModel>	getReturnEntryPagedGenericDao()
ReturnRequestData	getReturnForReturnCode(java.lang.String code)	API to get a ReturnRequestData by its code
protected GenericDao<ReturnRequestModel>	getReturnGenericDao()
protected Converter<ReturnRequestModel,ReturnRequestData>	getReturnHistoryConverter()
protected PagedGenericDao<ReturnRequestModel>	getReturnPagedGenericDao()
protected ReturnRequestModel	getReturnRequestModelForCode(java.lang.String code)	Finds ReturnRequestModel for the given "code"
SearchPageData<ReturnRequestData>	getReturns(PageableData pageableData)	API to get all returns in the system
SearchPageData<ReturnRequestData>	getReturnsByStatuses(PageableData pageableData, java.util.Set<ReturnStatus> returnStatusSet)	API to get all returns in the system that have certain status(s)
protected ReturnService	getReturnService()
java.util.List<ReturnStatus>	getReturnStatuses()	API to get all return statuses
protected java.math.BigDecimal	getTotalReturnEntriesAmount(ReturnRequestModel returnRequest)	Sums the amount of RefundEntryModel.getAmount() in the ReturnRequestModel
protected UserService	getUserService()
java.lang.Boolean	isCompleteReturn(OrderModel orderModel, ReturnRequestData returnRequestData)	API to check if the ReturnRequestData contains a complete order return.
boolean	isDeliveryCostRefundable(java.lang.String orderCode, java.lang.String returnRequestRMA)	Verifies if the delivery cost is refundable for the given order and return request.
protected boolean	isReturnCancellable(ReturnStatus status)	Checks whether the return can be cancelled
protected java.math.BigDecimal	recalculateSubtotal(ReturnRequestModel returnRequest, boolean completeReturn)	Recalculate the sub total after updating a refund amount
void	requestManualPaymentReversalForReturnRequest(java.lang.String code)	API to reverse payment manually for the returnRequest by its code
void	requestManualTaxReversalForReturnRequest(java.lang.String code)	API to reverse tax manually for the returnRequest by its code
void	setBaseStoreService(BaseStoreService baseStoreService)
void	setCustomerAccountService(CustomerAccountService customerAccountService)
void	setEnumerationService(EnumerationService enumerationService)
void	setEventService(EventService eventService)
void	setImpersonationService(ImpersonationService impersonationService)
void	setInvalidReturnStatusForRefundDeliveryCost(java.util.Set<ReturnStatus> invalidReturnStatusForRefundDeliveryCost)
void	setOrderService(OrderService orderService)
void	setRefundService(RefundService refundService)
void	setReturnCallbackService(ReturnCallbackService returnCallbackService)
void	setReturnConverter(Converter<ReturnRequestModel,ReturnRequestData> returnConverter)
void	setReturnEntryConverter(Converter<ReturnEntryModel,ReturnEntryData> returnEntryConverter)
void	setReturnEntryPagedGenericDao(PagedGenericDao<ReturnEntryModel> returnEntryPagedGenericDao)
void	setReturnGenericDao(GenericDao<ReturnRequestModel> returnGenericDao)
void	setReturnHistoryConverter(Converter<ReturnRequestModel,ReturnRequestData> returnHistoryConverter)
void	setReturnPagedGenericDao(PagedGenericDao<ReturnRequestModel> returnPagedGenericDao)
void	setReturnService(ReturnService returnService)
void	setUserService(UserService userService)
protected void	updateRefundDeliveryCost(ReturnRequestModificationData returnRequestModificationData, ReturnRequestModel returnRequest)	Update refundDeliveryCost if possible
protected void	updateReturnEntries(ReturnRequestModificationData returnRequestModificationData, ReturnRequestModel returnRequest)	Update return entries if possible
ReturnRequestData	updateReturnRequest(java.lang.String code, ReturnRequestModificationData returnRequestModificationData)	API to update the ReturnRequestModel
protected void	validateOrderEntryForReturnEntry(OrderEntryData orderEntry)	Validates for null check and mandatory fields in returnEntryData
protected void	validateReturnEntryData(ReturnEntryData returnEntryData)	Validates for null check and mandatory fields in returnEntryData
protected boolean	validateReturnEntryModificationData(ReturnRequestModificationData returnRequestModificationData)	Validate duplicated entries for ReturnEntryModificationData
protected void	validateReturnRequestData(ReturnRequestData returnRequestData)	Validates for null check and mandatory fields in returnRequestData
protected void	validateReturnStatus(ReturnRequestModel returnRequest, ReturnStatus expectedReturnStatus)	If ReturnRequestModel is not in the expected status for an update, a IllegalStateException will be thrown

Methods inherited from class de.hybris.platform.ordermanagementfacades.OmsBaseFacade

convertSearchPageData, createPaginationData, discardOrderSnapshot, getModelService, getOrderGenericDao, getOrderModelForCode, setModelService, setOrderGenericDao

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

DefaultOmsReturnFacade

public DefaultOmsReturnFacade()

Method Detail

getReturns

public SearchPageData<ReturnRequestData> getReturns(PageableData pageableData)

Description copied from interface: OmsReturnFacade

API to get all returns in the system

Specified by:

getReturns in interface OmsReturnFacade

Parameters:

pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info

Returns:

SearchPageData that contains a list of returns

getPagedReturnRequestsByCurrentUser

public SearchPageData<ReturnRequestData> getPagedReturnRequestsByCurrentUser(PageableData pageableData,
                                                                             ReturnStatus... returnStatuses)

Description copied from interface: OmsReturnFacade

Returns the paged ReturnRequestData for the current user.

Specified by:

getPagedReturnRequestsByCurrentUser in interface OmsReturnFacade

Parameters:

pageableData - paging information

returnStatuses - the list of ReturnStatus. If null or empty, all statuses are included.

Returns:

The ReturnRequestData for the current user.

getReturnsByStatuses

public SearchPageData<ReturnRequestData> getReturnsByStatuses(PageableData pageableData,
                                                              java.util.Set<ReturnStatus> returnStatusSet)

Description copied from interface: OmsReturnFacade

API to get all returns in the system that have certain status(s)

Specified by:

getReturnsByStatuses in interface OmsReturnFacade

Parameters:

pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info

returnStatusSet - set of return status(s) in which we want to get list of returns for.

Returns:

SearchPageData that contains a list of returns that complies with passed return status(es)

getReturnForReturnCode

public ReturnRequestData getReturnForReturnCode(java.lang.String code)

Description copied from interface: OmsReturnFacade

API to get a ReturnRequestData by its code

Specified by:

getReturnForReturnCode in interface OmsReturnFacade

Parameters:

code - the returnRequest's code

Returns:

the returnRequest

getCancelReasons

public java.util.List<CancelReason> getCancelReasons()

Description copied from interface: OmsReturnFacade

API to get all return cancel reasons

Specified by:

getCancelReasons in interface OmsReturnFacade

Returns:

a list of CancelReason

getReturnStatuses

public java.util.List<ReturnStatus> getReturnStatuses()

Description copied from interface: OmsReturnFacade

API to get all return statuses

Specified by:

getReturnStatuses in interface OmsReturnFacade

Returns:

a list of ReturnStatus

getRefundReasons

public java.util.List<RefundReason> getRefundReasons()

Description copied from interface: OmsReturnFacade

API to get all return refund reasons

Specified by:

getRefundReasons in interface OmsReturnFacade

Returns:

a list of RefundReason

getReturnActions

public java.util.List<ReturnAction> getReturnActions()

Description copied from interface: OmsReturnFacade

API to get all return actions

Specified by:

getReturnActions in interface OmsReturnFacade

Returns:

a list of ReturnAction

getReturnEntriesForReturnCode

public SearchPageData<ReturnEntryData> getReturnEntriesForReturnCode(java.lang.String code,
                                                                     PageableData pageableData)

Description copied from interface: OmsReturnFacade

API to get returnEntries for the given ReturnRequestModel.CODE

Specified by:

getReturnEntriesForReturnCode in interface OmsReturnFacade

Parameters:

code - the return's code

pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info

Returns:

SearchPageData that contains a list of the returnEntries for the given order

approveReturnRequest

public void approveReturnRequest(java.lang.String code)

Description copied from interface: OmsReturnFacade

API to approve the ReturnRequestModel by its code

Specified by:

approveReturnRequest in interface OmsReturnFacade

Parameters:

code - the code for the ReturnRequestModel to be approved

updateReturnRequest

public ReturnRequestData updateReturnRequest(java.lang.String code,
                                             ReturnRequestModificationData returnRequestModificationData)

Description copied from interface: OmsReturnFacade

API to update the ReturnRequestModel

Specified by:

updateReturnRequest in interface OmsReturnFacade

Parameters:

code - the return request's code

returnRequestModificationData - ReturnRequestModificationData

Returns:

ReturnRequestData

cancelReturnRequest

public void cancelReturnRequest(CancelReturnRequestData cancelReturnRequestData)

Description copied from interface: OmsReturnFacade

API to cancel a ReturnRequestModel

Specified by:

cancelReturnRequest in interface OmsReturnFacade

Parameters:

cancelReturnRequestData - contains information about the cancellation of the return request.

requestManualPaymentReversalForReturnRequest

public void requestManualPaymentReversalForReturnRequest(java.lang.String code)

Description copied from interface: OmsReturnFacade

API to reverse payment manually for the returnRequest by its code

Specified by:

requestManualPaymentReversalForReturnRequest in interface OmsReturnFacade

Parameters:

code - the code for the returnRequest

requestManualTaxReversalForReturnRequest

public void requestManualTaxReversalForReturnRequest(java.lang.String code)

Description copied from interface: OmsReturnFacade

API to reverse tax manually for the returnRequest by its code

Specified by:

requestManualTaxReversalForReturnRequest in interface OmsReturnFacade

Parameters:

code - the code for the returnRequest

createReturnRequest

public ReturnRequestData createReturnRequest(ReturnRequestData returnRequestData)

Description copied from interface: OmsReturnFacade

API to create a ReturnRequestModel

Specified by:

createReturnRequest in interface OmsReturnFacade

Parameters:

returnRequestData - the ReturnRequestData to create ReturnRequestModel

Returns:

the ReturnRequestData converted from the newly created ReturnRequestModel

isDeliveryCostRefundable

public boolean isDeliveryCostRefundable(java.lang.String orderCode,
                                        java.lang.String returnRequestRMA)

Description copied from interface: OmsReturnFacade

Verifies if the delivery cost is refundable for the given order and return request.

Specified by:

isDeliveryCostRefundable in interface OmsReturnFacade

Parameters:

orderCode - order code

returnRequestRMA - the return request RMA

Returns:

true if the delivery cost can be refunded

isCompleteReturn

public java.lang.Boolean isCompleteReturn(OrderModel orderModel,
                                          ReturnRequestData returnRequestData)

Description copied from interface: OmsReturnFacade

API to check if the ReturnRequestData contains a complete order return.

Specified by:

isCompleteReturn in interface OmsReturnFacade

Parameters:

orderModel - the OrderModel related to the return request

returnRequestData - the return form result ReturnRequestData

Returns:

true if it's a complete return.

recalculateSubtotal

protected java.math.BigDecimal recalculateSubtotal(ReturnRequestModel returnRequest,
                                                   boolean completeReturn)

Recalculate the sub total after updating a refund amount

Parameters:

returnRequest - ReturnRequestModel

getTotalReturnEntriesAmount

protected java.math.BigDecimal getTotalReturnEntriesAmount(ReturnRequestModel returnRequest)

Sums the amount of RefundEntryModel.getAmount() in the ReturnRequestModel

Parameters:

returnRequest - ReturnRequestModel

createReturnRequestInContext

protected ReturnRequestModel createReturnRequestInContext(OrderModel order,
                                                          ReturnRequestData returnRequestData)

Creates ReturnRequestModel in the ImpersonationContext

Parameters:

order - the OrderModel for which returnRequest needs to be created

returnRequestData - the ReturnRequestData containing required data to create ReturnRequestModel

Returns:

the newly created ReturnRequestModel

isReturnCancellable

protected boolean isReturnCancellable(ReturnStatus status)

Checks whether the return can be cancelled

Parameters:

status - current status of the return request

Returns:

whether the return request is cancellable

validateReturnRequestData

protected void validateReturnRequestData(ReturnRequestData returnRequestData)

Validates for null check and mandatory fields in returnRequestData

Parameters:

returnRequestData - returnRequest to be validated

validateReturnEntryData

protected void validateReturnEntryData(ReturnEntryData returnEntryData)

Validates for null check and mandatory fields in returnEntryData

Parameters:

returnEntryData - returnEntry to be validated

validateOrderEntryForReturnEntry

protected void validateOrderEntryForReturnEntry(OrderEntryData orderEntry)

Validates for null check and mandatory fields in returnEntryData

Parameters:

orderEntry - orderEntry to be validated

calculateRefundEntryAmount

protected java.math.BigDecimal calculateRefundEntryAmount(AbstractOrderEntryModel orderEntryModel,
                                                          java.lang.Long expectedQuantity,
                                                          boolean completeReturn)

Evaluates refundAmount for the RefundEntryModel to be created. If the order is not discounted, base price is used. Else: - For a complete order return: Discounted value is applied. - For a partial order return: A value of zero is applied.

Parameters:

orderEntryModel - the basePrice for the product to be refunded

expectedQuantity - expectedQuantity for the product to be refunded

completeReturn - if the return is a complete order return

Returns:

the amount in BigDecimal to be refunded for the RefundEntryModel

canRefundDeliveryCost

protected java.lang.Boolean canRefundDeliveryCost(java.lang.String orderCode,
                                                  java.lang.Boolean isDeliveryCostRequested)

Evaluates if deliveryCost should be refunded for the requested ReturnRequestModel to be created

Parameters:

orderCode - the orderCode's code for the requested returnRequest to be created

isDeliveryCostRequested - is deliveryCost requested in the request

Returns:

the boolean to indicate if deliveryCost should be refunded

getReturnRequestModelForCode

protected ReturnRequestModel getReturnRequestModelForCode(java.lang.String code)

Finds ReturnRequestModel for the given "code"

Parameters:

code - the returnRequest's code

Returns:

the requested return for the given code

updateReturnEntries

protected void updateReturnEntries(ReturnRequestModificationData returnRequestModificationData,
                                   ReturnRequestModel returnRequest)

Update return entries if possible

Parameters:

returnRequestModificationData - ReturnRequestModificationData

returnRequest - ReturnRequestModel

evaluateResultList

protected void evaluateResultList(ReturnEntryModificationData entry,
                                  java.util.List<ReturnEntryModel> resultList)

Verifies that the list is neither missing or duplicated and sets the RefundEntryModel.AMOUNT with the ReturnEntryModificationData.refundAmount

Parameters:

entry - the ReturnEntryModificationData

resultList - the result list to evaluate

updateRefundDeliveryCost

protected void updateRefundDeliveryCost(ReturnRequestModificationData returnRequestModificationData,
                                        ReturnRequestModel returnRequest)

Update refundDeliveryCost if possible

Parameters:

returnRequestModificationData - ReturnRequestModificationData

returnRequest - ReturnRequestModel

validateReturnStatus

protected void validateReturnStatus(ReturnRequestModel returnRequest,
                                    ReturnStatus expectedReturnStatus)

If ReturnRequestModel is not in the expected status for an update, a IllegalStateException will be thrown

Parameters:

returnRequest - ReturnRequestModel

expectedReturnStatus - ReturnStatus

validateReturnEntryModificationData

protected boolean validateReturnEntryModificationData(ReturnRequestModificationData returnRequestModificationData)

Validate duplicated entries for ReturnEntryModificationData

Parameters:

returnRequestModificationData - ReturnRequestModificationData

Returns:

true ReturnEntryModificationData the entry valid

getReturnPagedGenericDao

protected PagedGenericDao<ReturnRequestModel> getReturnPagedGenericDao()

setReturnPagedGenericDao

public void setReturnPagedGenericDao(PagedGenericDao<ReturnRequestModel> returnPagedGenericDao)

getReturnConverter

protected Converter<ReturnRequestModel,ReturnRequestData> getReturnConverter()

setReturnConverter

public void setReturnConverter(Converter<ReturnRequestModel,ReturnRequestData> returnConverter)

getReturnHistoryConverter

protected Converter<ReturnRequestModel,ReturnRequestData> getReturnHistoryConverter()

setReturnHistoryConverter

public void setReturnHistoryConverter(Converter<ReturnRequestModel,ReturnRequestData> returnHistoryConverter)

getEnumerationService

protected EnumerationService getEnumerationService()

setEnumerationService

public void setEnumerationService(EnumerationService enumerationService)

getReturnGenericDao

protected GenericDao<ReturnRequestModel> getReturnGenericDao()

setReturnGenericDao

public void setReturnGenericDao(GenericDao<ReturnRequestModel> returnGenericDao)

getReturnEntryPagedGenericDao

protected PagedGenericDao<ReturnEntryModel> getReturnEntryPagedGenericDao()

setReturnEntryPagedGenericDao

public void setReturnEntryPagedGenericDao(PagedGenericDao<ReturnEntryModel> returnEntryPagedGenericDao)

getReturnEntryConverter

protected Converter<ReturnEntryModel,ReturnEntryData> getReturnEntryConverter()

setReturnEntryConverter

public void setReturnEntryConverter(Converter<ReturnEntryModel,ReturnEntryData> returnEntryConverter)

getReturnService

protected ReturnService getReturnService()

setReturnService

public void setReturnService(ReturnService returnService)

getReturnCallbackService

protected ReturnCallbackService getReturnCallbackService()

setReturnCallbackService

public void setReturnCallbackService(ReturnCallbackService returnCallbackService)

getOrderService

protected OrderService getOrderService()

setOrderService

public void setOrderService(OrderService orderService)

getEventService

protected EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getRefundService

protected RefundService getRefundService()

setRefundService

public void setRefundService(RefundService refundService)

getImpersonationService

protected ImpersonationService getImpersonationService()

setImpersonationService

public void setImpersonationService(ImpersonationService impersonationService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getBaseStoreService

protected BaseStoreService getBaseStoreService()

setBaseStoreService

public void setBaseStoreService(BaseStoreService baseStoreService)

getCustomerAccountService

protected CustomerAccountService getCustomerAccountService()

setCustomerAccountService

public void setCustomerAccountService(CustomerAccountService customerAccountService)

getInvalidReturnStatusForRefundDeliveryCost

protected java.util.Set<ReturnStatus> getInvalidReturnStatusForRefundDeliveryCost()

setInvalidReturnStatusForRefundDeliveryCost

public void setInvalidReturnStatusForRefundDeliveryCost(java.util.Set<ReturnStatus> invalidReturnStatusForRefundDeliveryCost)