Interface ReturnOperationService
- 
- All Known Implementing Classes:
 DefaultReturnOperationService
public interface ReturnOperationServiceResponsible for managing operations on returns. 
- 
- 
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<com.broadleafcommerce.order.client.domain.ReturnAuthorization>cancelReturn(String orderId, CancelReturnRequest cancelReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)Cancel aReturnAuthorizationfor theOrderwith the givenorderId.com.broadleafcommerce.order.client.domain.ReturnAuthorizationconfirmReturn(String orderId, ConfirmReturnRequest confirmReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)CreateReturnConfirmationsforReturnAuthorizationItemswithin theOrderwith the givenorderId.com.broadleafcommerce.order.client.domain.ReturnAuthorizationcreateReturn(String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)Create aReturnAuthorizationfor theOrderwith the givenorderIdcontaining the items requested byreturnRequest.com.broadleafcommerce.order.client.domain.ReturnAuthorizationestimateReturn(String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)Estimate aReturnAuthorizationfor theOrderwith the givenorderIdcontaining the items requested byreturnRequest. 
 - 
 
- 
- 
Method Detail
- 
createReturn
com.broadleafcommerce.order.client.domain.ReturnAuthorization createReturn(String orderId, ReturnRequest returnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Create aReturnAuthorizationfor theOrderwith the givenorderIdcontaining the items requested byreturnRequest.- Parameters:
 orderId- the ID of the order with the items to returnreturnRequest- the request containing items to returncontextInfo- context information around sandbox and multitenant state- Returns:
 - the created 
ReturnAuthorization 
 
- 
confirmReturn
com.broadleafcommerce.order.client.domain.ReturnAuthorization confirmReturn(String orderId, ConfirmReturnRequest confirmReturnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
CreateReturnConfirmationsforReturnAuthorizationItemswithin theOrderwith the givenorderId.- Parameters:
 orderId- the ID of the order with the return having items confirmedconfirmReturnRequest- the request containing items to confirm as returnedcontextInfo- context information around sandbox and multitenant state- Returns:
 - the 
ReturnAuthorizationupdated with the newReturnConfirmations 
 
- 
cancelReturn
List<com.broadleafcommerce.order.client.domain.ReturnAuthorization> cancelReturn(String orderId, CancelReturnRequest cancelReturnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Cancel aReturnAuthorizationfor theOrderwith the givenorderId. Any already confirmedReturnAuthorizationItemsare extracted into a new separate confirmedReturnAuthorization, since they cannot be cancelled.- Parameters:
 orderId- the ID of the order with the return to cancelcancelReturnRequest- the request indicating which return to cancelcontextInfo- context information around sandbox and multitenant state- Returns:
 - the cancelled 
ReturnAuthorizationand possibly a newly separated confirmedReturnAuthorization, if there were any confirmations 
 
- 
estimateReturn
com.broadleafcommerce.order.client.domain.ReturnAuthorization estimateReturn(String orderId, ReturnRequest returnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Estimate aReturnAuthorizationfor theOrderwith the givenorderIdcontaining the items requested byreturnRequest.- Parameters:
 orderId- the ID of the order with the items to returnreturnRequest- the request containing items to returncontextInfo- context information around sandbox and multitenant state- Returns:
 - the created 
ReturnAuthorization 
 
 - 
 
 -