Package de.hybris.platform.returns

Interface OrderReturnRecordHandler

All Known Implementing Classes:

DefaultOrderReturnRecordsHandler, WarehousingOrderReturnRecordsHandler

public interface OrderReturnRecordHandler

Handles creation (based on OrderCancelRequests), of order return records in database

Method Summary

Modifier and Type	Method	Description
OrderReturnRecordEntryModel	createRefundEntry(OrderModel order, java.util.List<RefundEntryModel> refunds, java.lang.String description)	Persist a new return record entry that corresponds to the return request.
OrderReturnRecordModel	finalizeOrderReturnRecordForReturnRequest(ReturnRequestModel returnRequest)	Updates the OrderReturnRecordModel, and the corresponding OrderReturnRecordEntryModel, after the ReturnRequestModel is finalized
OrderReturnRecordEntryModel	getPendingReturnRecordEntryForReturnRequest(ReturnRequestModel returnRequest)	Get the OrderReturnRecordEntryModel, which is currently in progress state, for the given ReturnRequestModel
OrderReturnRecordModel	getReturnRecord(OrderModel order)	Get the whole return record for the given order

Method Detail

getReturnRecord

OrderReturnRecordModel getReturnRecord(OrderModel order)

Get the whole return record for the given order

Parameters:

order - target order

Returns:

OrderReturnRecordModel

createRefundEntry

OrderReturnRecordEntryModel createRefundEntry(OrderModel order,
                                              java.util.List<RefundEntryModel> refunds,
                                              java.lang.String description)
                                       throws OrderReturnRecordsHandlerException

Persist a new return record entry that corresponds to the return request.

Parameters:

order - OrderModel

refunds - RefundEntryModel

description - snapshot description

Returns:

OrderReturnRecordEntryModel

Throws:

OrderReturnRecordsHandlerException

finalizeOrderReturnRecordForReturnRequest

OrderReturnRecordModel finalizeOrderReturnRecordForReturnRequest(ReturnRequestModel returnRequest)

Updates the OrderReturnRecordModel, and the corresponding OrderReturnRecordEntryModel, after the ReturnRequestModel is finalized

Parameters:

returnRequest - the ReturnRequestModel being returned

Returns:

the updated OrderReturnRecordModel

getPendingReturnRecordEntryForReturnRequest

OrderReturnRecordEntryModel getPendingReturnRecordEntryForReturnRequest(ReturnRequestModel returnRequest)

Get the OrderReturnRecordEntryModel, which is currently in progress state, for the given ReturnRequestModel

Parameters:

returnRequest - the ReturnRequestModel being returned

Returns:

the in progress OrderReturnRecordEntryModel