Class OrderReturnsHelper
java.lang.Object
de.hybris.platform.commercewebservices.core.v2.helper.AbstractHelper
de.hybris.platform.commercewebservices.core.v2.helper.OrderReturnsHelper
Helper class for order returns
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcancelOrderReturnRequest(String orderReturnRequestCode) Cancels an order return requestcreateOrderReturnRequest(ReturnRequestEntryInputListWsDTO returnRequestEntryInputListWsDTO, String fields) Creates an order return requestprotected ReturnRequestsDataCreates a newReturnRequestsDatafromSearchPageDatagetOrderReturnRequest(String orderReturnRequestCode, String fields) Returns a return request by its codeprotected ReturnEntryDatamapToReturnEntryData(ReturnRequestEntryInputWsDTO entryInput) MapsReturnRequestEntryInputWsDTOtoReturnEntryDataalong with default values necessary for a return requestprotected voidpopulateReturnEntriesWithProductData(ReturnRequestData returnRequestData) Populates return entries ofReturnRequestDatawithProductDataprotected ReturnRequestDataprepareReturnRequestData(OrderData order, ReturnRequestEntryInputListWsDTO returnRequestEntryInputList) It prepares theReturnRequestDataobject by taking the order and the map of orderentriesOrderEntryDatanumber and returned quantitiessearchOrderReturnRequests(int currentPage, int pageSize, String sort, String fields) Returns the list of order return requests for the current userprotected voidvalidateUserForOrder(String orderCode) Validates if the current user has access to the orderMethods inherited from class de.hybris.platform.commercewebservices.core.v2.helper.AbstractHelper
createPageableData, getDataMapper, setDataMapper
-
Constructor Details
-
OrderReturnsHelper
public OrderReturnsHelper()
-
-
Method Details
-
searchOrderReturnRequests
public ReturnRequestListWsDTO searchOrderReturnRequests(int currentPage, int pageSize, String sort, String fields) Returns the list of order return requests for the current user- Parameters:
currentPage- The current result page requested.pageSize- he number of results returned per page.sort- Sorting method applied to the return results.fields- configuration for fields that will be returned inReturnRequestListWsDTO- Returns:
- The
ReturnRequestListWsDTOfor the current user.
-
getOrderReturnRequest
Returns a return request by its code- Parameters:
orderReturnRequestCode- Code of the order return requestfields- configuration for fields that will be returned inReturnRequestWsDTO- Returns:
- THe
ReturnRequestWsDTOwhich the code belongs to
-
cancelOrderReturnRequest
Cancels an order return request- Parameters:
orderReturnRequestCode- The code of the order return request which is requested to be cancelled
-
createOrderReturnRequest
public ReturnRequestWsDTO createOrderReturnRequest(ReturnRequestEntryInputListWsDTO returnRequestEntryInputListWsDTO, String fields) Creates an order return request- Parameters:
returnRequestEntryInputListWsDTO- The return request entry input list for an orderfields- configuration for fields that will be returned inReturnRequestWsDTO- Returns:
- The
ReturnRequestWsDTOconverted from the newly created return request
-
populateReturnEntriesWithProductData
Populates return entries ofReturnRequestDatawithProductData- Parameters:
returnRequestData- The return request data whose return entries are populated
-
createReturnRequestsData
Creates a newReturnRequestsDatafromSearchPageData- Parameters:
result- Search results- Returns:
ReturnRequestsDatawhich contains the information provided bySearchPageData
-
validateUserForOrder
Validates if the current user has access to the order- Parameters:
orderCode- the order code- Throws:
NotFoundException- if current user has no access to the order
-
prepareReturnRequestData
protected ReturnRequestData prepareReturnRequestData(OrderData order, ReturnRequestEntryInputListWsDTO returnRequestEntryInputList) It prepares theReturnRequestDataobject by taking the order and the map of orderentriesOrderEntryDatanumber and returned quantities- Parameters:
order- orderOrderDatawhich we want to returnreturnRequestEntryInputList- aReturnRequestEntryInputListWsDTOarray of order entries number and the returned quantities- Returns:
- returnRequest
ReturnRequestData
-
mapToReturnEntryData
MapsReturnRequestEntryInputWsDTOtoReturnEntryDataalong with default values necessary for a return request- Parameters:
entryInput- Return request entry input which will be mapped- Returns:
- The mapped
ReturnRequestEntryInputWsDTO
-