Package org.apache.ofbiz.order.order

Class OrderReturnServices

java.lang.Object

org.apache.ofbiz.order.order.OrderReturnServices

public class OrderReturnServices
extends Object

OrderReturnServices

Constructor Summary

Constructors

Constructor	Description
OrderReturnServices()

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	autoCancelReplacementOrders(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	checkPaymentAmountForRefund(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	checkReturnComplete(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	createPaymentApplicationsFromReturnItemResponse(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	createReturnAdjustment(DispatchContext dctx, Map<String,Object> context)
static Map<String,Object>	createReturnItemOrAdjustment(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	filterServiceContext(DispatchContext dctx, String serviceName, Map<String,? extends Object> context)	Deprecated. - Use DispatchContext.makeValidContext(String, String, Map) instead
static BigDecimal	getAdjustmentAmount(boolean isSalesTax, BigDecimal returnTotal, BigDecimal originalTotal, BigDecimal amount)	Calculate new returnAdjustment amount and set scale and rounding mode based on returnAdjustmentType: RET_SALES_TAX_ADJ use sales.tax.
static Map<String,Object>	getOrderAvailableReturnedTotal(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	getReturnableItems(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	getReturnableQuantity(DispatchContext dctx, Map<String,? extends Object> context)
static BigDecimal	getReturnAdjustmentTotal(Delegator delegator, Map<String,? extends Object> condition)	Get the total return adjustments for a set of key -> value condition pairs.
static Map<String,Object>	getReturnAmountByOrder(DispatchContext dctx, Map<String,? extends Object> context)
static BigDecimal	getReturnItemInitialCost(Delegator delegator, String returnId, String returnItemSeqId)
static Map<String,Object>	getReturnItemInitialCost(DispatchContext dctx, Map<String,? extends Object> context)
static void	groupReturnItemsByOrder(List<GenericValue> returnItems, Map<String,List<GenericValue>> returnItemsByOrderId, Map<String,BigDecimal> totalByOrder, Delegator delegator, String returnId, String returnTypeId)	Takes a List of returnItems and returns a Map of orderId -> items and a Map of orderId -> orderTotal
static boolean	needRecalculate(String returnAdjustmentTypeId)	These return adjustment types need to be recalculated when the return item is updated
static Map<String,Object>	processCreditReturn(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processRefundReturn(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processRefundReturnForReplacement(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processReplacementReturn(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	processSubscriptionReturn(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	refundBillingAccountPayment(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	sendReturnAcceptNotification(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	sendReturnCancelNotification(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	sendReturnCompleteNotification(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	updateReturnAdjustment(DispatchContext dctx, Map<String,Object> context)
static Map<String,Object>	updateReturnItemOrAdjustment(DispatchContext dctx, Map<String,? extends Object> context)

Methods inherited from class java.lang.Object

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

Constructor Details

OrderReturnServices

public OrderReturnServices()

Method Details

getReturnItemInitialCost

public static Map<String,Object> getReturnItemInitialCost(DispatchContext dctx,
 Map<String,? extends Object> context)

getOrderAvailableReturnedTotal

public static Map<String,Object> getOrderAvailableReturnedTotal(DispatchContext dctx,
 Map<String,? extends Object> context)

getReturnItemInitialCost

public static BigDecimal getReturnItemInitialCost(Delegator delegator,
 String returnId,
 String returnItemSeqId)

sendReturnAcceptNotification

public static Map<String,Object> sendReturnAcceptNotification(DispatchContext dctx,
 Map<String,? extends Object> context)

sendReturnCompleteNotification

public static Map<String,Object> sendReturnCompleteNotification(DispatchContext dctx,
 Map<String,? extends Object> context)

sendReturnCancelNotification

public static Map<String,Object> sendReturnCancelNotification(DispatchContext dctx,
 Map<String,? extends Object> context)

autoCancelReplacementOrders

public static Map<String,Object> autoCancelReplacementOrders(DispatchContext dctx,
 Map<String,? extends Object> context)

getReturnableQuantity

public static Map<String,Object> getReturnableQuantity(DispatchContext dctx,
 Map<String,? extends Object> context)

getReturnableItems

public static Map<String,Object> getReturnableItems(DispatchContext dctx,
 Map<String,? extends Object> context)

checkReturnComplete

public static Map<String,Object> checkReturnComplete(DispatchContext dctx,
 Map<String,? extends Object> context)

processCreditReturn

public static Map<String,Object> processCreditReturn(DispatchContext dctx,
 Map<String,? extends Object> context)

processRefundReturnForReplacement

public static Map<String,Object> processRefundReturnForReplacement(DispatchContext dctx,
 Map<String,? extends Object> context)

processRefundReturn

public static Map<String,Object> processRefundReturn(DispatchContext dctx,
 Map<String,? extends Object> context)

refundBillingAccountPayment

public static Map<String,Object> refundBillingAccountPayment(DispatchContext dctx,
 Map<String,? extends Object> context)

createPaymentApplicationsFromReturnItemResponse

public static Map<String,Object> createPaymentApplicationsFromReturnItemResponse(DispatchContext dctx,
 Map<String,? extends Object> context)

processReplacementReturn

public static Map<String,Object> processReplacementReturn(DispatchContext dctx,
 Map<String,? extends Object> context)

processSubscriptionReturn

public static Map<String,Object> processSubscriptionReturn(DispatchContext dctx,
 Map<String,? extends Object> context)

groupReturnItemsByOrder

public static void groupReturnItemsByOrder(List<GenericValue> returnItems,
 Map<String,List<GenericValue>> returnItemsByOrderId,
 Map<String,BigDecimal> totalByOrder,
 Delegator delegator,
 String returnId,
 String returnTypeId)

Takes a List of returnItems and returns a Map of orderId -> items and a Map of orderId -> orderTotal

Parameters:

returnItems - a List of return items

returnItemsByOrderId - the return items by order id

totalByOrder - the total by order id

delegator - the delegator

returnId - the return id

returnTypeId - the return type id

getReturnAmountByOrder

public static Map<String,Object> getReturnAmountByOrder(DispatchContext dctx,
 Map<String,? extends Object> context)

checkPaymentAmountForRefund

public static Map<String,Object> checkPaymentAmountForRefund(DispatchContext dctx,
 Map<String,? extends Object> context)

createReturnAdjustment

public static Map<String,Object> createReturnAdjustment(DispatchContext dctx,
 Map<String,Object> context)

updateReturnAdjustment

public static Map<String,Object> updateReturnAdjustment(DispatchContext dctx,
 Map<String,Object> context)

createReturnItemOrAdjustment

public static Map<String,Object> createReturnItemOrAdjustment(DispatchContext dctx,
 Map<String,? extends Object> context)

updateReturnItemOrAdjustment

public static Map<String,Object> updateReturnItemOrAdjustment(DispatchContext dctx,
 Map<String,? extends Object> context)

needRecalculate

public static boolean needRecalculate(String returnAdjustmentTypeId)

These return adjustment types need to be recalculated when the return item is updated

Parameters:

returnAdjustmentTypeId - the return adjustment type id

Returns:

returns if the returnn adjustment need to be recalculated

getReturnAdjustmentTotal

public static BigDecimal getReturnAdjustmentTotal(Delegator delegator,
 Map<String,? extends Object> condition)

Get the total return adjustments for a set of key -> value condition pairs. Done for code efficiency.

Parameters:

delegator - the delegator

condition - the conditions to use

Returns:

return the total return adjustments

filterServiceContext

@Deprecated
public static Map<String,Object> filterServiceContext(DispatchContext dctx,
 String serviceName,
 Map<String,? extends Object> context)
                                               throws GenericServiceException

Deprecated.

- Use DispatchContext.makeValidContext(String, String, Map) instead

Get rid of unnecessary parameters based on the given service name

Parameters:

dctx - Service DispatchContext

serviceName - the service name

context - context before clean up

Returns:

filtered context

Throws:

GenericServiceException

getAdjustmentAmount

public static BigDecimal getAdjustmentAmount(boolean isSalesTax,
 BigDecimal returnTotal,
 BigDecimal originalTotal,
 BigDecimal amount)

Calculate new returnAdjustment amount and set scale and rounding mode based on returnAdjustmentType: RET_SALES_TAX_ADJ use sales.tax.

Parameters:

isSalesTax - if returnAdjustmentType is SaleTax

returnTotal -

originalTotal -

amount -

Returns:

new returnAdjustment amount