DT-798 added minimum shipper request fields

dcsaorg · May 14, 2024 · 873aefe · 873aefe
1 parent edabef8
commit 873aefe
Show file tree

Hide file tree

Showing 11 changed files with 90 additions and 22 deletions.
diff --git a/booking/src/main/java/org/dcsa/conformance/standards/booking/checks/BookingChecks.java b/booking/src/main/java/org/dcsa/conformance/standards/booking/checks/BookingChecks.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.core.JsonPointer;
 import com.fasterxml.jackson.databind.JsonNode;
+import lombok.NonNull;
 import lombok.experimental.UtilityClass;
 import org.dcsa.conformance.core.check.*;
 import org.dcsa.conformance.core.traffic.HttpMessageType;
@@ -306,31 +307,17 @@ private static Consumer<MultiAttributeValidator> allDg(Consumer<MultiAttributeVa
     "Validate shipmentLocations",
     body -> {
       var issues = new LinkedHashSet<String>();
-      var shipmentLocations = body.path("shipmentLocations");
       var receiptTypeAtOrigin = body.path("receiptTypeAtOrigin").asText("");
-      var polNode =
-        StreamSupport.stream(shipmentLocations.spliterator(), false)
-          .filter(o ->  o.path("locationTypeCode").asText("").equals("POL")
-            || o.path("locationTypeCode").asText("").equals("PRE") )
-          .findFirst()
-          .orElse(null);
-      var podNode =
-        StreamSupport.stream(shipmentLocations.spliterator(), false)
-          .filter(o -> o.path("locationTypeCode").asText("").equals("POD")
-          || o.path("locationTypeCode").asText("").equals("PDE") )
-          .findFirst()
-          .orElse(null);
-
-      var ielNode =
-        StreamSupport.stream(shipmentLocations.spliterator(), false)
-          .filter(o ->  o.path("locationTypeCode").asText("").equals("IEL"))
-          .findFirst()
-          .orElse(null);
-
-      if (podNode == null || podNode.isEmpty() ) {
+      var polNode = getShipmenLocationTypeCode(body,"POL");
+      var preNode = getShipmenLocationTypeCode(body,"PRE");
+      var pdeNode = getShipmenLocationTypeCode(body,"PDE");
+      var podNode = getShipmenLocationTypeCode(body,"POD");
+      var ielNode = getShipmenLocationTypeCode(body,"IEL");
+
+      if ((pdeNode == null || pdeNode.isEmpty()) && (podNode == null || podNode.isEmpty()) ) {
         issues.add("Port of Discharge/Place of Delivery value must be provided");
       }
-      if (polNode == null || polNode.isEmpty()) {
+      if ((preNode == null || preNode.isEmpty()) && (polNode == null || polNode.isEmpty())) {
         issues.add("Port of Load/Place of Receipt values must be provided");
       }
       if(!"SD".equals(receiptTypeAtOrigin) && ielNode != null) {
@@ -339,6 +326,47 @@ private static Consumer<MultiAttributeValidator> allDg(Consumer<MultiAttributeVa
       return issues;
     });
 
+  private static final JsonContentCheck VALIDATE_SHIPPER_MINIMUM_REQUEST_FIELDS = JsonAttribute.customValidator(
+    "Validate shipper's minimum request fields",
+    body -> {
+      var issues = new LinkedHashSet<String>();
+      var vesselName = body.has("vessel") ? body.path("vessel").path("name").asText(""): "";
+      var carrierExportVoyageNumber = body.path("carrierExportVoyageNumber").asText("");
+      var carrierServiceCode = body.path("carrierServiceCode").asText("");
+      var carrierServiceName = body.path("carrierServiceName").asText("");
+      var expectedDepartureDate = body.path("expectedDepartureDate").asText("");
+
+      var polNode = getShipmenLocationTypeCode(body,"POL");
+      var preNode = getShipmenLocationTypeCode(body,"PRE");
+      var pdeNode = getShipmenLocationTypeCode(body,"PDE");
+      var podNode = getShipmenLocationTypeCode(body,"POD");
+
+      String providedArrivalStartDate = body.path("expectedArrivalAtPlaceOfDeliveryStartDate").asText("");
+      String providedArrivalEndDate = body.path("expectedArrivalAtPlaceOfDeliveryEndDate").asText("");
+
+      var isPodAbsent = (pdeNode == null || pdeNode.isEmpty()) && (podNode == null || podNode.isEmpty());
+      var isPolAbsent = (preNode == null || preNode.isEmpty()) && (polNode == null || polNode.isEmpty());
+
+      var poldServiceCodeAbsent = (isPolAbsent && isPodAbsent && vesselName.isEmpty() && carrierExportVoyageNumber.isEmpty())
+        || (isPolAbsent && isPodAbsent && carrierServiceCode.isEmpty() && carrierExportVoyageNumber.isEmpty())
+        || (isPolAbsent && isPodAbsent && carrierServiceName.isEmpty() && carrierExportVoyageNumber.isEmpty());
+
+      var poldExpectedDepartureDateAbsent = isPolAbsent && isPodAbsent && expectedDepartureDate.isEmpty() ;
+
+      var poldArrivalStartEndDateAbsent = isPolAbsent && isPodAbsent && providedArrivalStartDate.isEmpty() && providedArrivalEndDate.isEmpty();
+
+      if ( poldServiceCodeAbsent || poldExpectedDepartureDateAbsent || poldArrivalStartEndDateAbsent ) {
+        issues.add("The minimum options to provide shipper's requested fields are missing.");
+      }
+       return issues;
+    });
+  private static JsonNode getShipmenLocationTypeCode(JsonNode body, @NonNull String locationTypeCode) {
+    var shipmentLocations = body.path("shipmentLocations");
+    return StreamSupport.stream(shipmentLocations.spliterator(), false)
+      .filter(o ->  o.path("locationTypeCode").asText("").equals(locationTypeCode))
+      .findFirst()
+      .orElse(null);
+  }
 
   private static final JsonContentCheck REQUESTED_CHANGES_PRESENCE = JsonAttribute.customValidator(
     "Requested changes must be present for the selected Booking Status ",
@@ -546,6 +574,7 @@ private static void generateScenarioRelatedChecks(List<JsonContentCheck> checks,
     VALIDATE_SHIPMENT_CUTOFF_TIME_CODE,
     VALIDATE_ALLOWED_SHIPMENT_CUTOFF_CODE,
     COUNTRY_CODE_VALIDATIONS,
+    VALIDATE_SHIPPER_MINIMUM_REQUEST_FIELDS,
     JsonAttribute.atLeastOneOf(
       JsonPointer.compile("/expectedDepartureDate"),
       JsonPointer.compile("/expectedArrivalAtPlaceOfDeliveryStartDate"),

diff --git a/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-dg.json b/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-dg.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",

diff --git a/...g/src/main/resources/standards/booking/messages/booking-api-2.0.0-reefer-temp-change.json b/...g/src/main/resources/standards/booking/messages/booking-api-2.0.0-reefer-temp-change.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": false,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "42R0",

diff --git a/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-reefer.json b/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-reefer.json
@@ -12,6 +12,9 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "42R0",

diff --git a/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-2re1c.json b/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-2re1c.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",

diff --git a/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-2re2c.json b/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-2re2c.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",

diff --git a/...ing/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-cho-dest.json b/...ing/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-cho-dest.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",

diff --git a/...ing/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-cho-orig.json b/...ing/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular-cho-orig.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": false,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",

diff --git a/.../resources/standards/booking/messages/booking-api-2.0.0-regular-non-operating-reefer.json b/.../resources/standards/booking/messages/booking-api-2.0.0-regular-non-operating-reefer.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": false,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "42R0",

diff --git a/...rc/main/resources/standards/booking/messages/booking-api-2.0.0-regular-shipper-owned.json b/...rc/main/resources/standards/booking/messages/booking-api-2.0.0-regular-shipper-owned.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": false,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "45G1",

diff --git a/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular.json b/booking/src/main/resources/standards/booking/messages/booking-api-2.0.0-regular.json
@@ -12,6 +12,10 @@
   "isImportLicenseRequired": true,
   "communicationChannelCode": "AO",
   "isEquipmentSubstitutionAllowed": true,
+  "carrierServiceCode": "TA1",
+  "vessel": {
+    "name": "King of the Seas"
+  },
   "requestedEquipments": [
     {
       "ISOEquipmentCode": "22GP",