0036709: Add a hook in OrderLoader.java before adding a shipment line

diff --git a/src/org/openbravo/retail/posterminal/OrderLoader.java b/src/org/openbravo/retail/posterminal/OrderLoader.java
--- a/src/org/openbravo/retail/posterminal/OrderLoader.java
+++ b/src/org/openbravo/retail/posterminal/OrderLoader.java
@@ -160,6 +160,10 @@
   @Any
   private Instance<OrderLoaderPreProcessPaymentHook> preProcessPayment;
 
+  @Inject
+  @Any
+  private Instance<OrderLoaderPreAddShipmentLineHook> preAddShipmentLine;
+
   private boolean useOrderDocumentNoForRelatedDocs = false;
 
   protected String getImportQualifier() {
@@ -610,10 +614,10 @@
     Collections.sort(hookList, new Comparator<Object>() {
       @Override
       public int compare(Object o1, Object o2) {
-        int o1Priority = (o1 instanceof PreOrderLoaderPrioritizedHook) ? ((PreOrderLoaderPrioritizedHook) o1).getPriority()
-            : 100;
-        int o2Priority = (o2 instanceof PreOrderLoaderPrioritizedHook) ? ((PreOrderLoaderPrioritizedHook) o2).getPriority()
-            : 100;
+        int o1Priority = (o1 instanceof PreOrderLoaderPrioritizedHook) ? ((PreOrderLoaderPrioritizedHook) o1)
+            .getPriority() : 100;
+        int o2Priority = (o2 instanceof PreOrderLoaderPrioritizedHook) ? ((PreOrderLoaderPrioritizedHook) o2)
+            .getPriority() : 100;
 
         return (int) Math.signum(o2Priority - o1Priority);
       }
@@ -646,6 +650,21 @@
     }
   }
 
+  protected boolean executeOrderLoaderPreAddShipmentLineHook(Instance<? extends Object> hooks,
+      String action, JSONObject jsonorderline, OrderLine orderline, JSONObject jsonorder,
+      Order order, Locator bin) throws Exception {
+    for (Iterator<? extends Object> procIter = hooks.iterator(); procIter.hasNext();) {
+      Object proc = procIter.next();
+      if (proc instanceof OrderLoaderPreAddShipmentLineHook) {
+        if (!((OrderLoaderPreAddShipmentLineHook) proc).exec(action, jsonorderline, orderline,
+            jsonorder, order, bin)) {
+          return false;
+        }
+      }
+    }
+    return true;
+  }
+
   private void associateOrderToQuotation(JSONObject jsonorder, Order order) throws JSONException {
     String quotationId = jsonorder.getString("oldId");
     Order quotation = OBDal.getInstance().get(Order.class, quotationId);
@@ -1190,10 +1209,28 @@
         } else {
           binForReturn = getBinForReturns(jsonorder.getString("posTerminal"));
         }
+
+        try {
+          executeOrderLoaderPreAddShipmentLineHook(preAddShipmentLine, "Return",
+              orderlines.getJSONObject(i), orderLine, jsonorder, order, binForReturn);
+        } catch (Exception e) {
+          log.error("An error happened executing hook OrderLoaderPreAddShipmentLineHook "
+              + e.getMessage());
+        }
+
         addShipmentline(shipment, shplineentity, orderlines.getJSONObject(i), orderLine, jsonorder,
             lineNo, pendingQty.negate(), binForReturn, null, i);
       } else if (useSingleBin && pendingQty.compareTo(BigDecimal.ZERO) > 0) {
         lineNo += 10;
+
+        try {
+          executeOrderLoaderPreAddShipmentLineHook(preAddShipmentLine, "SingleBinSale",
+              orderlines.getJSONObject(i), orderLine, jsonorder, order, foundSingleBin);
+        } catch (Exception e) {
+          log.error("An error happened executing hook OrderLoaderPreAddShipmentLineHook "
+              + e.getMessage());
+        }
+
         addShipmentline(shipment, shplineentity, orderlines.getJSONObject(i), orderLine, jsonorder,
             lineNo, pendingQty, foundSingleBin, null, i);
       } else {
@@ -1222,6 +1259,17 @@
               StockProposed stock = (StockProposed) bins.get(0);
               BigDecimal qty;
 
+              try {
+                if (!executeOrderLoaderPreAddShipmentLineHook(preAddShipmentLine, "SimpleSale",
+                    orderlines.getJSONObject(i), orderLine, jsonorder, order, stock
+                        .getStorageDetail().getStorageBin())) {
+                  continue;
+                }
+              } catch (Exception e) {
+                log.error("An error happened executing hook OrderLoaderPreAddShipmentLineHook "
+                    + e.getMessage());
+              }
+
               Object stockQty = stock.get("quantity");
               if (stockQty instanceof Long) {
                 stockQty = new BigDecimal((Long) stockQty);
diff --git a/src/org/openbravo/retail/posterminal/OrderLoaderPreAddShipmentLineHook.java b/src/org/openbravo/retail/posterminal/OrderLoaderPreAddShipmentLineHook.java
new file mode 100644
--- /dev/null
+++ b/src/org/openbravo/retail/posterminal/OrderLoaderPreAddShipmentLineHook.java
@@ -0,0 +1,21 @@
+/*
+ ************************************************************************************
+ * Copyright (C) 2017 Openbravo S.L.U.
+ * Licensed under the Openbravo Commercial License version 1.0
+ * You may obtain a copy of the License at http://www.openbravo.com/legal/obcl.html
+ * or in the legal folder of this module distribution.
+ ************************************************************************************
+ */
+
+package org.openbravo.retail.posterminal;
+
+import org.codehaus.jettison.json.JSONObject;
+import org.openbravo.model.common.enterprise.Locator;
+import org.openbravo.model.common.order.Order;
+import org.openbravo.model.common.order.OrderLine;
+
+public abstract class OrderLoaderPreAddShipmentLineHook {
+  // Return true if everything goes well
+  public abstract boolean exec(String action, JSONObject jsonorderline, OrderLine orderline,
+      JSONObject jsonorder, Order order, Locator bin) throws Exception;
+}
\ No newline at end of file