From 281ef8c12cdfc685c0c768576ed0edcc6717dcd4 Mon Sep 17 00:00:00 2001
From: Aron Roberts <aron@socrates.berkeley.edu>
Date: Wed, 19 Feb 2014 17:22:09 -0800
Subject: [PATCH] CSPACE-6129: When computing a Cataloging record's current
 location from related L/M/I (Movement) records, if two or more such records
 have identical location dates, use their update timestamps as a tiebreaker.

---
 .../batch/batch-update-object-loc.xml         | 202 ++++++++++++++++++
 .../nuxeo/UpdateObjectLocationBatchJob.java   |  17 ++
 2 files changed, 219 insertions(+)

diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/batch/batch-update-object-loc.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/batch/batch-update-object-loc.xml
index d2033a1c1..d68b1ac5c 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/batch/batch-update-object-loc.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/batch/batch-update-object-loc.xml
@@ -7,6 +7,7 @@
     </auths>
         
     <!-- This tests the UpdateObjectLocationBatchJob -->
+    <!-- in various invocation modes -->
         
     <testGroup ID="invocationModeSingle" autoDeletePOSTS="true">
         
@@ -282,6 +283,207 @@
         
     </testGroup>
     
+    <testGroup ID="invocationModeSingleWithTiebreaker" autoDeletePOSTS="true">
+                    
+        <test ID="createBatchRecordWithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/batch</uri>
+            <filename>batch/batch-create-updateobjloc.xml</filename>
+            <expectedCodes>201</expectedCodes>
+        </test>
+                
+        <test ID="createCollectionObjectWithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/collectionobjects</uri>
+            <filename>batch/collObj1.xml</filename>
+            <expectedCodes>201</expectedCodes>
+        </test>
+        
+        <test ID="createMovement1WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/movements</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-1-with-tiebreaker</var>
+                <var ID="locationDate">1900-01-01</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+        
+        <test ID="createMovement2WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/movements</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-2-with-tiebreaker</var>
+                <var ID="locationDate">${createMovement1WithTiebreaker.locationDate}</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+        
+        <test ID="createMovement3WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/movements</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-3-with-tiebreaker</var>
+                <var ID="locationDate">${createMovement1WithTiebreaker.locationDate}</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+        
+        <test ID="relateCollectionObjectToMovement1WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/relations</uri>
+            <filename>batch/relation.xml</filename>
+            <vars>
+                <var ID="subjectCsid">${createCollectionObjectWithTiebreaker.CSID}</var>
+                <var ID="subjectDocumentType">CollectionObject</var>
+                <var ID="objectCsid">${createMovement1WithTiebreaker.CSID}</var>
+                <var ID="objectDocumentType">Movement</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+        
+        <test ID="relateCollectionObjectToMovement2WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/relations</uri>
+            <filename>batch/relation.xml</filename>
+            <vars>
+                <var ID="subjectCsid">${createCollectionObjectWithTiebreaker.CSID}</var>
+                <var ID="subjectDocumentType">CollectionObject</var>
+                <var ID="objectCsid">${createMovement2WithTiebreaker.CSID}</var>
+                <var ID="objectDocumentType">Movement</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+         
+        <test ID="relateCollectionObjectToMovement3WithTiebreaker">
+            <method>POST</method>
+            <uri>/cspace-services/relations</uri>
+            <filename>batch/relation.xml</filename>
+            <vars>
+                <var ID="subjectCsid">${createCollectionObjectWithTiebreaker.CSID}</var>
+                <var ID="subjectDocumentType">CollectionObject</var>
+                <var ID="objectCsid">${createMovement3WithTiebreaker.CSID}</var>
+                <var ID="objectDocumentType">Movement</var>
+            </vars>
+            <expectedCodes>201</expectedCodes>
+        </test>
+
+        <test ID="modifyMovement1WithTiebreaker">
+            <method>PUT</method>
+            <uri>/cspace-services/movements/${createMovement1WithTiebreaker.CSID}</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-1-modified-with-tiebreaker</var>
+                <var ID="locationDate">${createMovement1WithTiebreaker.locationDate}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test>
+ 
+        <test ID="invokeBatchAfterMovement1ModificationWithTiebreaker" auth="test" autoDeletePOSTS="false">
+            <method>POST</method>
+            <uri>/cspace-services/batch/${createBatchRecordWithTiebreaker.CSID}</uri>
+            <filename>batch/batch-invoke-updateobjloc-single.xml</filename>
+            <vars>
+                <var ID="collectionObjectCSID">${createCollectionObjectWithTiebreaker.CSID}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test> 
+        
+        <!-- Verify that, following the invocation of the batch job, the -->
+        <!-- computedCurrentLocation field in the CollectionObject record has -->
+        <!-- been updated to the appropriate value, reflecting the most recent -->
+        <!-- movement (e.g. the Movement record with the most recent locationDate, -->
+        <!-- and, as in this test group - where two Movement records have identical -->
+        <!-- locationDate values - the Movement record that has been updated most recently. -->
+        <test ID="readCollectionObjectAfterMovement1ModificationWithTiebreaker">
+            <method>GET</method>
+            <uri>/cspace-services/collectionobjects/${createCollectionObjectWithTiebreaker.CSID}</uri>
+            <filename>batch/updateobjloc.xml</filename>
+            <response>
+                <expected level="ADDOK" />
+                <filename>batch/res/collectionobject.res.xml</filename>
+                <vars>
+                    <var ID="computedCurrentLocationValue">${modifyMovement1WithTiebreaker.currentLocation}</var>
+                </vars>
+            </response>
+            <expectedCodes>200</expectedCodes>
+        </test>      
+
+        <test ID="modifyMovement2WithTiebreaker">
+            <method>PUT</method>
+            <uri>/cspace-services/movements/${createMovement2WithTiebreaker.CSID}</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-2-modified-with-tiebreaker</var>
+                <var ID="locationDate">${createMovement1WithTiebreaker.locationDate}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test>
+ 
+        <test ID="invokeBatchAfterMovement2ModificationWithTiebreaker" auth="test" autoDeletePOSTS="false">
+            <method>POST</method>
+            <uri>/cspace-services/batch/${createBatchRecordWithTiebreaker.CSID}</uri>
+            <filename>batch/batch-invoke-updateobjloc-single.xml</filename>
+            <vars>
+                <var ID="collectionObjectCSID">${createCollectionObjectWithTiebreaker.CSID}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test> 
+        
+        <test ID="readCollectionObjectRecordAfterMovement2ModificationWithTiebreaker">
+            <method>GET</method>
+            <uri>/cspace-services/collectionobjects/${createCollectionObjectWithTiebreaker.CSID}</uri>
+            <filename>batch/updateobjloc.xml</filename>
+            <response>
+                <expected level="ADDOK" />
+                <filename>batch/res/collectionobject.res.xml</filename>
+                <vars>
+                    <var ID="computedCurrentLocationValue">${modifyMovement2WithTiebreaker.currentLocation}</var>
+                </vars>
+            </response>
+            <expectedCodes>200</expectedCodes>
+        </test>
+        
+        <test ID="modifyMovement3WithTiebreaker">
+            <method>PUT</method>
+            <uri>/cspace-services/movements/${createMovement3WithTiebreaker.CSID}</uri>
+            <filename>batch/movement.xml</filename>
+            <vars>
+                <var ID="currentLocation">location-3-modified-with-tiebreaker</var>
+                <var ID="locationDate">${createMovement1WithTiebreaker.locationDate}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test>
+ 
+        <test ID="invokeBatchAfterMovement3ModificationWithTiebreaker" auth="test" autoDeletePOSTS="false">
+            <method>POST</method>
+            <uri>/cspace-services/batch/${createBatchRecordWithTiebreaker.CSID}</uri>
+            <filename>batch/batch-invoke-updateobjloc-single.xml</filename>
+            <vars>
+                <var ID="collectionObjectCSID">${createCollectionObjectWithTiebreaker.CSID}</var>
+            </vars>
+            <expectedCodes>200</expectedCodes>
+        </test> 
+        
+        <test ID="readCollectionObjectRecordAfterMovement3ModificationWithTiebreaker">
+            <method>GET</method>
+            <uri>/cspace-services/collectionobjects/${createCollectionObjectWithTiebreaker.CSID}</uri>
+            <filename>batch/updateobjloc.xml</filename>
+            <response>
+                <expected level="ADDOK" />
+                <filename>batch/res/collectionobject.res.xml</filename>
+                <vars>
+                    <var ID="computedCurrentLocationValue">${modifyMovement3WithTiebreaker.currentLocation}</var>
+                </vars>
+            </response>
+            <expectedCodes>200</expectedCodes>
+        </test>
+            
+    </testGroup>
+    
     <testGroup ID="invocationModeList" autoDeletePOSTS="true">
         
         <test ID="createBatchRecord">
diff --git a/services/batch/service/src/main/java/org/collectionspace/services/batch/nuxeo/UpdateObjectLocationBatchJob.java b/services/batch/service/src/main/java/org/collectionspace/services/batch/nuxeo/UpdateObjectLocationBatchJob.java
index 36ef17097..590f0cac8 100644
--- a/services/batch/service/src/main/java/org/collectionspace/services/batch/nuxeo/UpdateObjectLocationBatchJob.java
+++ b/services/batch/service/src/main/java/org/collectionspace/services/batch/nuxeo/UpdateObjectLocationBatchJob.java
@@ -41,6 +41,7 @@ public class UpdateObjectLocationBatchJob extends AbstractBatchInvocable {
     private final static String LIFECYCLE_STATE_ELEMENT_NAME = "currentLifeCycleState";
     private final static String LOCATION_DATE_ELEMENT_NAME = "locationDate";
     private final static String OBJECT_NUMBER_ELEMENT_NAME = "objectNumber";
+    private final static String UPDATE_DATE_ELEMENT_NAME = "updatedAt";
     private final static String WORKFLOW_COMMON_SCHEMA_NAME = "workflow_common";
     private final static String WORKFLOW_COMMON_NAMESPACE_PREFIX = "ns2";
     private final static String WORKFLOW_COMMON_NAMESPACE_URI =
@@ -200,7 +201,9 @@ public class UpdateObjectLocationBatchJob extends AbstractBatchInvocable {
         String movementCsid;
         String currentLocation;
         String locationDate;
+        String updateDate;
         String mostRecentLocationDate = "";
+        String comparisonUpdateDate = "";
         for (AbstractCommonList.ListItem movementListItem : relatedMovements.getListItem()) {
             movementCsid = AbstractCommonListUtils.ListItemGetElementValue(movementListItem, CSID_ELEMENT_NAME);
             if (Tools.isBlank(movementCsid)) {
@@ -218,6 +221,10 @@ public class UpdateObjectLocationBatchJob extends AbstractBatchInvocable {
             if (Tools.isBlank(locationDate)) {
                 continue;
             }
+            updateDate = AbstractCommonListUtils.ListItemGetElementValue(movementListItem, UPDATE_DATE_ELEMENT_NAME);
+            if (Tools.isBlank(updateDate)) {
+                continue;
+            }
             currentLocation = AbstractCommonListUtils.ListItemGetElementValue(movementListItem, CURRENT_LOCATION_ELEMENT_NAME);
             if (Tools.isBlank(currentLocation)) {
                 continue;
@@ -229,6 +236,7 @@ public class UpdateObjectLocationBatchJob extends AbstractBatchInvocable {
             // value of a parameter passed in during batch job invocation.
             if (logger.isTraceEnabled()) {
                 logger.trace("Location date value = " + locationDate);
+                logger.trace("Update date value = " + updateDate);
                 logger.trace("Current location value = " + currentLocation);
             }
             // If this record's location date value is more recent than that of other
@@ -244,6 +252,15 @@ public class UpdateObjectLocationBatchJob extends AbstractBatchInvocable {
             if (locationDate.compareTo(mostRecentLocationDate) > 0) {
                 mostRecentLocationDate = locationDate;
                 mostRecentMovement = movementListItem;
+                comparisonUpdateDate = updateDate;
+            } else if (locationDate.compareTo(mostRecentLocationDate) == 0) {
+                // If the two location dates match, then use a tiebreaker
+                if (updateDate.compareTo(comparisonUpdateDate) > 0) {
+                    // The most recent location date value doesn't need to be
+                    // updated here, as the two records' values are identical
+                    mostRecentMovement = movementListItem;
+                    comparisonUpdateDate = updateDate;
+                }
             }
 
         }
-- 
2.47.3