Fixes #8

--APIv1EndpointOrgProcurePurchaseOrderFromSupplier.java
Added method to be able to obtain the index of the purchase order record and line that contains the unstocked supplier products.

--APIv1EndpointResponseESD.java
Added property to be able to obtain unstock order lines from procurement endpoint.

--APIv1ExampleRunnerProcurePurchaseOrderFromSupplier.java
Modified main method to show example of how to set text line in purchase orders, as well as how to handle unstocked error exception.

Author: Rowan Drew

src/org/squizz/api/v1/endpoint/APIv1EndpointOrgProcurePurchaseOrderFromSupplier.java

@@ -151,4 +151,44 @@ public static ArrayList<Pair<Integer, Integer>> getUnpricedOrderLines(ESDocument
 
         return unpricedOrderLines;
     }
+    
+    /**
+     * gets a list of order indexes that contain order lines that could not be stocked for a supplier organisation's products
+     * @param esDocument Ecommerce standards document containing configuration that specifies unpriced order lines
+     * @return an array containing pairs. Each pair has the index of the order, and the index of the order line that could not be stocked
+     */
+    public static ArrayList<Pair<Integer, Integer>> getUnstockedOrderLines(ESDocument esDocument)
+    {
+        ArrayList<Pair<Integer, Integer>> unstockedOrderLines = new ArrayList<>();
+        
+        //check that the ecommerce standards document's configs contains a key specifying the unstocked order lines
+        if(esDocument.configs.containsKey(APIv1EndpointResponseESD.ESD_CONFIG_ORDERS_WITH_UNSTOCKED_LINES))
+        {
+            //get comma separated list of order record indicies and line indicies that indicate the unstocked order lines
+            String unstockedOrderLineCSV = esDocument.configs.get(APIv1EndpointResponseESD.ESD_CONFIG_ORDERS_WITH_UNSTOCKED_LINES);
+
+            //get the index of the order record and line that contained the unstocked product
+            if(!unstockedOrderLineCSV.trim().isEmpty()){
+                String[] unmappedOrderLineIndices = unstockedOrderLineCSV.trim().split(",");
+
+                //iterate through each order-line index
+                for(int i=0; i < unmappedOrderLineIndices.length; i++){
+                    //get order index and line index
+                    String[] orderLineIndex = unmappedOrderLineIndices[i].split(":");
+                    if(orderLineIndex.length == 2){
+                        try{
+                            int orderIndex = Integer.parseInt(orderLineIndex[0]);
+                            int lineIndex = Integer.parseInt(orderLineIndex[1]);
+                            Pair<Integer, Integer> orderLinePair = new Pair<>(orderIndex, lineIndex);
+                            unstockedOrderLines.add(orderLinePair);
+
+                        }catch(Exception ex){
+                        }
+                    }
+                }
+            }
+        }
+        
+        return unstockedOrderLines;
+    }
 }

src/org/squizz/api/v1/endpoint/APIv1EndpointResponseESD.java

@@ -17,6 +17,7 @@ public class APIv1EndpointResponseESD
 {
     public static final String ESD_CONFIG_ORDERS_WITH_UNMAPPED_LINES = "orders_with_unmapped_lines";
     public static final String ESD_CONFIG_ORDERS_WITH_UNPRICED_LINES = "orders_with_unpriced_lines";
+    public static final String ESD_CONFIG_ORDERS_WITH_UNSTOCKED_LINES = "orders_with_unstocked_lines";
 
     //set default values for the response
     public String result = ENDPOINT_RESULT_FAILURE;

test/org/squizz/api/v1/example/APIv1ExampleRunnerProcurePurchaseOrderFromSupplier.java

@@ -93,7 +93,6 @@ public static void main(String[] args)
             orderProduct.lineType = ESDocumentConstants.ORDER_LINE_TYPE_PRODUCT;
             orderProduct.productCode = "TEA-TOWEL-GREEN";
             orderProduct.productName = "Green tea towel - 30 x 6 centimetres";
-            orderProduct.keySellUnitID = "2";
             orderProduct.unitName = "EACH";
             orderProduct.quantity = 4;
             orderProduct.sellUnitBaseQuantity = 4;
@@ -104,8 +103,22 @@ public static void main(String[] args)
             orderProduct.priceTotalIncTax = 22.00;
             orderProduct.priceTotalExTax = 20.00;
             orderProduct.priceTotalTax = 2.00;
+            orderLines.add(orderProduct);
+            
+            //add a 2nd purchase order line record that is a text line
+            orderProduct = new ESDRecordOrderPurchaseLine();
+            orderProduct.lineType = ESDocumentConstants.ORDER_LINE_TYPE_TEXT;
+            orderProduct.productCode = "TEA-TOWEL-BLUE";
+            orderProduct.textDescription = "Please bundle tea towels into a box";
+            orderLines.add(orderProduct);
 
-            //add order line to lines list
+            //add a 3rd purhase order line record
+            orderProduct = new ESDRecordOrderPurchaseLine();
+            orderProduct.lineType = ESDocumentConstants.ORDER_LINE_TYPE_PRODUCT;
+            orderProduct.productCode = "PINKDOU";
+            orderProduct.productName = "Blue tea towel - 30 x 6 centimetres";
+            orderProduct.quantity = 2;
+            orderProduct.salesOrderProductCode = "ACME-SUPPLIER-TTBLUE"; 
             orderLines.add(orderProduct);
 
             //add order lines to the order
@@ -185,6 +198,27 @@ else if(endpointResponseESD.result_code.equals(APIv1EndpointResponse.ENDPOINT_RE
                         }
                     }
                 }
+                //if one or more products in the purchase order did not have stock available by the supplier organisation then find the order line that caused the problem
+                else if(endpointResponseESD.result_code.equals(APIv1EndpointResponse.ENDPOINT_RESULT_CODE_ERROR_ORDER_MAPPED_PRODUCT_STOCK_NOT_AVAILABLE) && esDocumentOrderSale != null)
+                {
+                    if(esDocumentOrderSale.configs.containsKey(APIv1EndpointResponseESD.ESD_CONFIG_ORDERS_WITH_UNSTOCKED_LINES))
+                    {
+                        //get a list of order lines that could not be stocked
+                        ArrayList<Pair<Integer, Integer>> unstockedLines = APIv1EndpointOrgProcurePurchaseOrderFromSupplier.getUnstockedOrderLines(esDocumentOrderSale);
+
+                        //iterate through each unstocked order line
+                        for(Pair<Integer, Integer> unstockedLine : unstockedLines){
+                            //get the index of the purchase order and line that contained the unstocked product
+                            int orderIndex = unstockedLine.getKey();
+                            int lineIndex = unstockedLine.getValue();
+
+                            //check that the order can be found that contains the problematic line
+                            if(orderIndex < orderPurchaseESD.dataRecords.length && lineIndex < orderPurchaseESD.dataRecords[orderIndex].lines.size()){
+                                System.out.println("For purchase order: "+ orderPurchaseESD.dataRecords[orderIndex].purchaseOrderCode + " the supplier has no stock available for line number: " + (lineIndex+1));
+                            }
+                        }
+                    }
+                }
             }
 		}