AYS-224 | Emergency Evacuation Application Update

src/main/java/org/ays/emergency_application/controller/EmergencyEvacuationApplicationController.java

@@ -10,6 +10,7 @@
 import org.ays.emergency_application.model.mapper.EmergencyEvacuationApplicationToApplicationsResponseMapper;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationListRequest;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationRequest;
+import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationUpdateRequest;
 import org.ays.emergency_application.model.response.EmergencyEvacuationApplicationResponse;
 import org.ays.emergency_application.model.response.EmergencyEvacuationApplicationsResponse;
 import org.ays.emergency_application.service.EmergencyEvacuationApplicationService;
@@ -19,6 +20,7 @@
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -89,4 +91,27 @@ public AysResponse<Void> create(@RequestBody @Valid EmergencyEvacuationApplicati
         return AysResponse.SUCCESS;
     }
 
+
+    /**
+     * Updates an existing Emergency Evacuation Application.
+     * This method accepts a PUT request
+     * <p>
+     * This endpoint updates the Emergency Evacuation Application with the specified ID using the provided update request.
+     * The request body and path variable validated before processing.
+     * The user must have the authority 'application:evacuation:update' to access this endpoint.
+     * </p>
+     *
+     * @param id the unique identifier of the Emergency Evacuation Application to be updated
+     * @param updateRequest the request object containing the details to update the Emergency Evacuation Application
+     * @return a response indicating the success of the update operation
+     */
+    @PutMapping("/emergency-evacuation-application/{id}")
+    @PreAuthorize("hasAuthority('application:evacuation:update')")
+    public AysResponse<Void> update(@PathVariable @UUID final String id,
+                                    @RequestBody @Valid final EmergencyEvacuationApplicationUpdateRequest updateRequest) {
+
+        emergencyEvacuationApplicationService.update(id, updateRequest);
+        return AysResponse.SUCCESS;
+    }
+
 }

src/main/java/org/ays/emergency_application/model/entity/EmergencyEvacuationApplicationEntity.java

@@ -11,10 +11,10 @@
 import jakarta.persistence.OneToOne;
 import jakarta.persistence.Table;
 import lombok.AllArgsConstructor;
-import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
+import lombok.experimental.SuperBuilder;
 import org.ays.common.model.entity.BaseEntity;
 import org.ays.institution.model.entity.InstitutionEntity;
 
@@ -25,7 +25,7 @@
 @Entity
 @Getter
 @Setter
-@Builder
+@SuperBuilder
 @NoArgsConstructor
 @AllArgsConstructor
 @Table(name = "AYS_EMERGENCY_EVACUATION_APPLICATION")
@@ -100,6 +100,6 @@ public class EmergencyEvacuationApplicationEntity extends BaseEntity {
 
     @OneToOne
     @JoinColumn(name = "INSTITUTION_ID", insertable = false, updatable = false)
-    private InstitutionEntity institutionEntity;
+    private InstitutionEntity institution;
 
 }

src/main/java/org/ays/emergency_application/model/mapper/EmergencyEvacuationApplicationToEntityMapper.java

@@ -23,6 +23,7 @@ public interface EmergencyEvacuationApplicationToEntityMapper extends BaseMapper
     @Mapping(target = "lineNumber", source = "phoneNumber.lineNumber")
     @Mapping(target = "applicantCountryCode", source = "applicantPhoneNumber.countryCode")
     @Mapping(target = "applicantLineNumber", source = "applicantPhoneNumber.lineNumber")
+    @Mapping(target = "institutionId", source = "institution.id")
     EmergencyEvacuationApplicationEntity map(EmergencyEvacuationApplication application);
 
     /**

src/main/java/org/ays/emergency_application/model/mapper/EmergencyEvacuationApplicationUpdateRequestToDomainMapper.java

@@ -0,0 +1,29 @@
+package org.ays.emergency_application.model.mapper;
+
+import org.ays.common.model.mapper.BaseMapper;
+import org.ays.emergency_application.model.EmergencyEvacuationApplication;
+import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationUpdateRequest;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+/**
+ * {@link EmergencyEvacuationApplicationUpdateRequestToDomainMapper} is an interface that defines the
+ * mapping between an {@link EmergencyEvacuationApplicationUpdateRequest} and an {@link EmergencyEvacuationApplication}.
+ * This interface uses the MapStruct annotation @Mapper to generate an implementation of this interface at compile-time.
+ * <p>The class provides a static method {@code initialize()} that returns an instance of the generated mapper implementation.
+ * <p>The interface extends the MapStruct interface {@link BaseMapper}, which defines basic mapping methods.
+ * The interface adds no additional mapping methods, but simply defines the types to be used in the mapping process.
+ */
+@Mapper
+public interface EmergencyEvacuationApplicationUpdateRequestToDomainMapper extends BaseMapper<EmergencyEvacuationApplicationUpdateRequest, EmergencyEvacuationApplication> {
+
+    /**
+     * Initializes the mapper.
+     *
+     * @return the initialized mapper object.
+     */
+    static EmergencyEvacuationApplicationUpdateRequestToDomainMapper initialize() {
+        return Mappers.getMapper(EmergencyEvacuationApplicationUpdateRequestToDomainMapper.class);
+    }
+
+}

src/main/java/org/ays/emergency_application/model/request/EmergencyEvacuationApplicationUpdateRequest.java

@@ -0,0 +1,48 @@
+package org.ays.emergency_application.model.request;
+
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.Getter;
+import lombok.Setter;
+import org.ays.emergency_application.model.entity.EmergencyEvacuationApplicationStatus;
+import org.hibernate.validator.constraints.Range;
+
+/**
+ * A request object for updating an Emergency Evacuation Application.
+ * <p>
+ * This class contains the details necessary for updating an existing
+ * Emergency Evacuation Application.
+ * </p>
+ */
+@Getter
+@Setter
+public class EmergencyEvacuationApplicationUpdateRequest {
+
+    /**
+     * The number of seats available.
+     * Must be between 1 and 999.
+     */
+    @NotNull
+    @Range(min = 1, max = 999)
+    private Integer seatingCount;
+
+    /**
+     * Indicates if there is a person with obstacles present.
+     */
+    @NotNull
+    private Boolean hasObstaclePersonExist;
+
+    /**
+     * The current status of the Emergency Evacuation Application.
+     */
+    @NotNull
+    private EmergencyEvacuationApplicationStatus status;
+
+    /**
+     * Additional notes regarding the application.
+     * The notes can have a maximum length of 1000 characters.
+     */
+    @Size(max = 1000)
+    private String notes;
+
+}

src/main/java/org/ays/emergency_application/service/EmergencyEvacuationApplicationService.java

@@ -4,6 +4,7 @@
 import org.ays.emergency_application.model.EmergencyEvacuationApplication;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationListRequest;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationRequest;
+import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationUpdateRequest;
 
 /**
  * Emergency evacuation application service to perform emergency evacuation related operations
@@ -32,4 +33,10 @@ public interface EmergencyEvacuationApplicationService {
      * @return The emergency evacuation application with the specified ID, or null if not found.
      */
     EmergencyEvacuationApplication findById(String id);
+
+    // TODO : Add javadoc
+    void update(
+            String id,
+            EmergencyEvacuationApplicationUpdateRequest updateRequest
+    );
 }

src/main/java/org/ays/emergency_application/service/impl/EmergencyEvacuationApplicationServiceImpl.java

@@ -1,20 +1,26 @@
 package org.ays.emergency_application.service.impl;
 
 import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
+import org.ays.auth.model.AysIdentity;
 import org.ays.common.model.AysPage;
 import org.ays.common.model.AysPageable;
 import org.ays.emergency_application.model.EmergencyEvacuationApplication;
 import org.ays.emergency_application.model.filter.EmergencyEvacuationApplicationFilter;
-import org.ays.emergency_application.model.mapper.EmergencyEvacuationApplicationRequestToDomainMapper;
+import org.ays.emergency_application.model.mapper.EmergencyEvacuationApplicationUpdateRequestToDomainMapper;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationListRequest;
 import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationRequest;
+import org.ays.emergency_application.model.request.EmergencyEvacuationApplicationUpdateRequest;
 import org.ays.emergency_application.port.EmergencyEvacuationApplicationReadPort;
 import org.ays.emergency_application.port.EmergencyEvacuationApplicationSavePort;
 import org.ays.emergency_application.service.EmergencyEvacuationApplicationService;
 import org.ays.emergency_application.util.exception.EmergencyEvacuationApplicationNotExistException;
+import org.ays.institution.model.Institution;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.util.Optional;
+
 /**
  * This class implements the interface {@link EmergencyEvacuationApplicationService}
  * It is annotated with {@code @Service} to indicate that it is a service component in the application.
@@ -28,9 +34,11 @@ class EmergencyEvacuationApplicationServiceImpl implements EmergencyEvacuationAp
 
     private final EmergencyEvacuationApplicationReadPort emergencyEvacuationApplicationReadPort;
     private final EmergencyEvacuationApplicationSavePort emergencyEvacuationApplicationSavePort;
+    private final AysIdentity identity;
 
+    private final EmergencyEvacuationApplicationUpdateRequestToDomainMapper applicationUpdateRequestToDomainMapper =
+            EmergencyEvacuationApplicationUpdateRequestToDomainMapper.initialize();
 
-    private final EmergencyEvacuationApplicationRequestToDomainMapper emergencyEvacuationApplicationRequestToDomainMapper = EmergencyEvacuationApplicationRequestToDomainMapper.initialize();
 
     /**
      * Retrieves a page of emergency evacuation applications based on the provided request parameters.
@@ -70,12 +78,44 @@ public EmergencyEvacuationApplication findById(final String id) {
     @Transactional
     public void create(final EmergencyEvacuationApplicationRequest emergencyEvacuationApplicationRequest) {
 
-        EmergencyEvacuationApplication application = emergencyEvacuationApplicationRequestToDomainMapper
+        EmergencyEvacuationApplication application = applicationUpdateRequestToDomainMapper
                 .map(emergencyEvacuationApplicationRequest);
 
         application.pending();
 
         emergencyEvacuationApplicationSavePort.save(application);
     }
 
+    /**
+     * Updates an existing Emergency Evacuation Application with the provided details
+     *
+     * @param id the unique identifier of the Emergency Evacuation Application to be updated
+     * @param updateRequest the request object containing the details to update the Emergency Evacuation Application
+     * @throws EmergencyEvacuationApplicationNotExistException if the application with the specified ID does not exist
+     */
+    @Override
+    @Transactional
+    public void update(final String id,
+                       final EmergencyEvacuationApplicationUpdateRequest updateRequest) {
+
+        final EmergencyEvacuationApplication emergencyEvacuationApplication = emergencyEvacuationApplicationReadPort
+                .findById(id)
+                .orElseThrow(() -> new EmergencyEvacuationApplicationNotExistException(id));
+
+        emergencyEvacuationApplication.setInstitution(
+                Institution.builder()
+                        .id(identity.getInstitutionId())
+                        .build()
+        );
+        emergencyEvacuationApplication.setSeatingCount(updateRequest.getSeatingCount());
+        emergencyEvacuationApplication.setHasObstaclePersonExist(updateRequest.getHasObstaclePersonExist());
+        emergencyEvacuationApplication.setStatus(updateRequest.getStatus());
+
+        Optional.ofNullable(updateRequest.getNotes())
+                .filter(StringUtils::isNotBlank)
+                .ifPresent(emergencyEvacuationApplication::setNotes);
+
+        emergencyEvacuationApplicationSavePort.save(emergencyEvacuationApplication);
+    }
+
 }