de.hybris.platform.ordercancel

Interface OrderCancelRecordsHandler

All Known Implementing Classes:

DefaultOrderCancelRecordsHandler, WarehousingOrderCancelRecordsHandler

public interface OrderCancelRecordsHandler

Handles creation (based on OrderCancelRequests), updating (OrderCancelResponse) of order cancel records in database

Method Summary

Modifier and Type	Method and Description
OrderCancelRecordEntryModel	createRecordEntry(OrderCancelRequest request) Persist a new cancel record entry that corresponds to the cancel request.
OrderCancelRecordEntryModel	createRecordEntry(OrderCancelRequest request, PrincipalModel requestor) Persist a new cancel record entry that corresponds to the cancel request.
OrderCancelRecordModel	getCancelRecord(OrderModel order) Get the whole cancel record for the given order
OrderCancelRecordEntryModel	getPendingCancelRecordEntry(OrderModel order) Get the cancel record entry is currently in progress state
OrderCancelRecordEntryModel	updateRecordEntry(OrderCancelResponse response) Updates cancel record entry basing on the cancel response.

Method Detail

getCancelRecord

OrderCancelRecordModel getCancelRecord(OrderModel order)

Get the whole cancel record for the given order

Parameters:

order - target order

Returns:

OrderCancelRecordModel

getPendingCancelRecordEntry

OrderCancelRecordEntryModel getPendingCancelRecordEntry(OrderModel order)
                                                 throws OrderCancelRecordsHandlerException

Get the cancel record entry is currently in progress state

Parameters:

order -

Returns:

OrderCancelRecordEntryModel

Throws:

OrderCancelRecordsHandlerException

createRecordEntry

OrderCancelRecordEntryModel createRecordEntry(OrderCancelRequest request)
                                       throws OrderCancelRecordsHandlerException

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

Parameters:

request - OrderCancelRequest

Returns:

OrderCancelRecordEntryModel - a model reference to the entry.

Throws:

OrderCancelRecordsHandlerException

createRecordEntry

OrderCancelRecordEntryModel createRecordEntry(OrderCancelRequest request,
                                              PrincipalModel requestor)
                                       throws OrderCancelRecordsHandlerException

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

Parameters:

request - OrderCancelRequest

requestor - - who requests the cancel

Returns:

OrderCancelRecordEntryModel - a model reference to the entry.

Throws:

OrderCancelRecordsHandlerException

updateRecordEntry

OrderCancelRecordEntryModel updateRecordEntry(OrderCancelResponse response)
                                       throws OrderCancelRecordsHandlerException

Updates cancel record entry basing on the cancel response. Entry should already be created earlier.

Parameters:

response - OrderCancelResponse

Returns:

OrderCancelRecordEntryModel - a model reference to the entry.

Throws:

OrderCancelRecordsHandlerException