BAH-4464 changed into default method for extensibility

Author: lingeswaranTW

api/src/main/java/org/openmrs/module/appointments/service/AppointmentNumberGenerator.java

@@ -4,8 +4,28 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import javax.validation.constraints.NotNull;
+import java.util.List;
+import java.util.Objects;
 
 @Transactional
 public interface AppointmentNumberGenerator {
     String generateAppointmentNumber(@NotNull Appointment appointment);
+
+    /**
+     * Apply appointment numbers to a batch of appointments.
+     * Default behavior: generate one number and apply to all (shared number strategy).*
+     * @param appointments List of appointments to apply numbers to. Null or empty lists are ignored.
+     */
+    default void applyAppointmentNumbers(@NotNull List<Appointment> appointments) {
+        if (appointments == null || appointments.isEmpty()) {
+            return;
+        }
+
+        String sharedNumber = generateAppointmentNumber(appointments.get(0));
+        appointments.forEach(appointment -> {
+            if (appointment.getAppointmentNumber() == null) {
+                appointment.setAppointmentNumber(sharedNumber);
+            }
+        });
+    }
 }

api/src/main/java/org/openmrs/module/appointments/service/impl/AppointmentRecurringPatternServiceImpl.java

@@ -90,45 +90,45 @@ public AppointmentRecurringPattern update(AppointmentRecurringPattern appointmen
     }
 
     private void updateAppointmentsDetails(AppointmentRecurringPattern appointmentRecurringPattern, List<Appointment> appointments)  {
-        // Generate or reuse appointment number for the entire recurring series
-        String sharedAppointmentNumber = getOrGenerateSharedAppointmentNumber(appointments);
+        assignAppointmentNumbers(appointments);
 
         appointments.forEach(appointment -> {
-            // Use the shared appointment number for all appointments
-            if (appointment.getAppointmentNumber() == null) {
-                appointment.setAppointmentNumber(sharedAppointmentNumber);
-            }
             setAppointmentAudit(appointment);
             appointment.setAppointmentRecurringPattern(appointmentRecurringPattern);
         });
     }
 
-    private String getOrGenerateSharedAppointmentNumber(List<Appointment> appointments) {
+    private void assignAppointmentNumbers(List<Appointment> appointments) {
         if (appointments.isEmpty()) {
-            return null;
+            return;
         }
 
-        // Check if any appointment already has a number (for adding to existing series)
         String existingAppointmentNumber = appointments.stream()
                 .map(Appointment::getAppointmentNumber)
                 .filter(number -> number != null)
                 .findFirst()
                 .orElse(null);
 
         if (existingAppointmentNumber != null) {
-            return existingAppointmentNumber;
+            // All must use existing number
+            appointments.forEach(appointment -> {
+                if (appointment.getAppointmentNumber() == null) {
+                    appointment.setAppointmentNumber(existingAppointmentNumber);
+                }
+            });
+            return;
         }
 
-        // Generate new number for new series
+        // Delegate to generator's batch method
         AppointmentNumberGenerator appointmentNumberGenerator =
                 appointmentNumberGeneratorLocator.retrieveAppointmentNumberGenerator();
 
         if (appointmentNumberGenerator == null) {
             log.warn("Can not generate appointment number. No generator found");
-            return null;
+            return;
         }
 
-        return appointmentNumberGenerator.generateAppointmentNumber(appointments.get(0));
+        appointmentNumberGenerator.applyAppointmentNumbers(appointments);
     }
 
     @Override

api/src/test/java/org/openmrs/module/appointments/service/impl/AppointmentRecurringPatternServiceImplTest.java

@@ -43,6 +43,7 @@
 import static org.mockito.Matchers.anyString;
 import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.anyListOf;
+import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.doThrow;
@@ -96,10 +97,18 @@ public void shouldSaveRecurringAppointmentsForGivenRecurringPatternAndAppointmen
         List<Appointment> appointments = Collections.singletonList(appointment);
         appointmentRecurringPattern.setAppointments(new HashSet<>(appointments));
         String notes = "Notes";
+        String generatedNumber = "TEST123";
+
         doReturn(notes).when(appointmentServiceHelper).getAppointmentAsJsonString(appointment);
         doReturn(appointmentAudit).when(appointmentServiceHelper).getAppointmentAuditEvent(appointment, notes);
         doNothing().when(appointmentRecurringPatternDao).save(appointmentRecurringPattern);
 
+        // Mock applyAppointmentNumbers to set the appointment number
+        doAnswer(invocation -> {
+            List<Appointment> appts = invocation.getArgument(0);
+            appts.forEach(a -> a.setAppointmentNumber(generatedNumber));
+            return null;
+        }).when(appointmentNumberGenerator).applyAppointmentNumbers(anyListOf(Appointment.class));
 
         //setting up the number generator locator
         recurringAppointmentService.setAppointmentNumberGeneratorLocator(
@@ -112,7 +121,7 @@ public void shouldSaveRecurringAppointmentsForGivenRecurringPatternAndAppointmen
         verify(appointmentRecurringPatternDao).save(appointmentRecurringPattern);
         verify(appointmentServiceHelper).getAppointmentAsJsonString(appointment);
         verify(appointmentServiceHelper).getAppointmentAuditEvent(appointment, notes);
-        verify(appointmentNumberGenerator).generateAppointmentNumber(appointment);
+        verify(appointmentNumberGenerator).applyAppointmentNumbers(anyListOf(Appointment.class));
         assertEquals(1, appointmentRecurringPattern.getAppointments().size());
         assertEquals(1, appointmentsList.get(0).getAppointmentAudits().size());
     }
@@ -284,18 +293,27 @@ public void shouldSaveAndReturnTheUpdatedRecurringPatternWhenUpdateIsCalled() th
         AppointmentAudit appointmentAudit = new AppointmentAudit();
         appointmentRecurringPattern.setAppointments(new HashSet<>(appointments));
         String notes = "Notes";
+        String generatedNumber = "TEST123";
+
         doNothing().when(appointmentRecurringPatternDao).save(appointmentRecurringPattern);
         doReturn(notes).when(appointmentServiceHelper).getAppointmentAsJsonString(appointment);
         doReturn(appointmentAudit).when(appointmentServiceHelper).getAppointmentAuditEvent(appointment, notes);
 
+        // Mock applyAppointmentNumbers to set the appointment number
+        doAnswer(invocation -> {
+            List<Appointment> appts = invocation.getArgument(0);
+            appts.forEach(a -> a.setAppointmentNumber(generatedNumber));
+            return null;
+        }).when(appointmentNumberGenerator).applyAppointmentNumbers(anyListOf(Appointment.class));
+
         recurringAppointmentService.setAppointmentNumberGeneratorLocator(
                 new AppointmentNumberGeneratorLocatorImpl(appointmentNumberGenerator));
         recurringAppointmentService.update(appointmentRecurringPattern, appointment);
 
         verify(appointmentRecurringPatternDao, times(1)).save(appointmentRecurringPattern);
         verify(appointmentServiceHelper).getAppointmentAsJsonString(appointment);
         verify(appointmentServiceHelper).getAppointmentAuditEvent(appointment, notes);
-        verify(appointmentNumberGenerator).generateAppointmentNumber(appointment);
+        verify(appointmentNumberGenerator).applyAppointmentNumbers(anyListOf(Appointment.class));
     }
 
     @Test
@@ -383,6 +401,19 @@ public void shouldAssignSameAppointmentNumberToAllNewRecurringAppointments() thr
 
         when(appointmentNumberGenerator.generateAppointmentNumber(any(Appointment.class)))
                 .thenReturn(sharedAppointmentNumber);
+
+        // Mock applyAppointmentNumbers to use the mocked generateAppointmentNumber
+        doAnswer(invocation -> {
+            List<Appointment> appts = invocation.getArgument(0);
+            String number = appointmentNumberGenerator.generateAppointmentNumber(appts.get(0));
+            appts.forEach(a -> {
+                if (a.getAppointmentNumber() == null) {
+                    a.setAppointmentNumber(number);
+                }
+            });
+            return null;
+        }).when(appointmentNumberGenerator).applyAppointmentNumbers(anyListOf(Appointment.class));
+
         doReturn(notes).when(appointmentServiceHelper).getAppointmentAsJsonString(any());
         doReturn(appointmentAudit).when(appointmentServiceHelper).getAppointmentAuditEvent(any(), anyString());
         doNothing().when(appointmentRecurringPatternDao).save(appointmentRecurringPattern);
@@ -395,7 +426,7 @@ public void shouldAssignSameAppointmentNumberToAllNewRecurringAppointments() thr
         assertEquals(sharedAppointmentNumber, appointmentOne.getAppointmentNumber());
         assertEquals(sharedAppointmentNumber, appointmentTwo.getAppointmentNumber());
         assertEquals(sharedAppointmentNumber, appointmentThree.getAppointmentNumber());
-        verify(appointmentNumberGenerator, times(1)).generateAppointmentNumber(any());
+        verify(appointmentNumberGenerator, times(1)).applyAppointmentNumbers(anyListOf(Appointment.class));
     }
 
     @Test