HDPI-6454 Caseworker remove document

build.gradle

@@ -338,7 +338,9 @@ sonarqube {
       "**/model/**," +
       "**/uk/gov/hmcts/reform/pcs/testingsupport/**/*.java"
     property "sonar.cpd.exclusions", "**/uk/gov/hmcts/reform/pcs/ccd/domain/enforcetheorder/warrant/StatementOfTruthDetails.java," +
-      "**/uk/gov/hmcts/reform/pcs/ccd/domain/genapp/*.java,"
+      "**/uk/gov/hmcts/reform/pcs/ccd/domain/genapp/*.java," +
+      "**/uk/gov/hmcts/reform/pcs/ccd/domain/documentamend/DocumentAmendDetails.java," +
+      "**/uk/gov/hmcts/reform/pcs/ccd/domain/documentremoval/DocumentRemovalDetails.java,"
   }
 }
 

src/main/java/uk/gov/hmcts/reform/pcs/ccd/accesscontrol/ManageDocumentStates.java

@@ -0,0 +1,22 @@
+package uk.gov.hmcts.reform.pcs.ccd.accesscontrol;
+
+import uk.gov.hmcts.reform.pcs.ccd.domain.State;
+
+public final class ManageDocumentStates {
+
+    public static final State[] MANAGE_DOCUMENT_STATES = {
+        State.PENDING_CASE_ISSUED,
+        State.CASE_ISSUED,
+        State.CASE_PROGRESSION,
+        State.CASE_STAYED,
+        State.BREATHING_SPACE,
+        State.JUDICIAL_REFERRAL,
+        State.HEARING_READINESS,
+        State.PREPARE_FOR_HEARING_CONDUCT_HEARING,
+        State.DECISION_OUTCOME,
+        State.ALL_FINAL_ORDERS_ISSUED
+    };
+
+    private ManageDocumentStates() {
+    }
+}

src/main/java/uk/gov/hmcts/reform/pcs/ccd/domain/DocumentSelectionDetails.java

@@ -0,0 +1,20 @@
+package uk.gov.hmcts.reform.pcs.ccd.domain;
+
+import uk.gov.hmcts.ccd.sdk.type.YesOrNo;
+
+public interface DocumentSelectionDetails {
+
+    CaseFileCategory getSelectedFolder();
+
+    void setPropertyAddressSummary(String propertyAddressSummary);
+
+    void setEmptyForCategory(CaseFileCategory category, YesOrNo empty);
+
+    void setSelectedFolderId(String id);
+
+    void setSelectedFolderLabel(String label);
+
+    void setSelectedDocumentId(String id);
+
+    void setSelectedDocumentFileName(String fileName);
+}

src/main/java/uk/gov/hmcts/reform/pcs/ccd/domain/PCSCase.java

@@ -34,6 +34,8 @@
 import uk.gov.hmcts.reform.pcs.ccd.domain.dashboard.DashboardData;
 import uk.gov.hmcts.reform.pcs.ccd.domain.documentupload.DocumentUploadDetails;
 import uk.gov.hmcts.reform.pcs.ccd.domain.documentamend.DocumentAmendDetails;
+import uk.gov.hmcts.reform.pcs.ccd.domain.documentremoval.DocumentRemovalDetails;
+import uk.gov.hmcts.reform.pcs.ccd.domain.documentupload.DocumentUploadDetails;
 import uk.gov.hmcts.reform.pcs.ccd.domain.enforcetheorder.EnforcementOrder;
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.CitizenGenAppRequest;
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.GeneralApplication;
@@ -486,6 +488,36 @@ public class PCSCase {
     @JsonUnwrapped(prefix = "documentAmend_")
     private DocumentAmendDetails documentAmendDetails;
 
+    @JsonUnwrapped(prefix = "documentRemoval_")
+    private DocumentRemovalDetails documentRemovalDetails;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList statementsOfCaseDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList propertyDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList evidenceDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList hearingDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList ordersAndNoticeOfHearingsDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList applicationsDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList appealsDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList correspondenceDocuments;
+
+    @CCD(searchable = false, typeOverride = DynamicRadioList)
+    private DynamicList uncategorisedDocuments;
+
     @CCD(
         label = "Are you planning to make an application at the same time as your claim?",
         hint = "After you’ve submitted your claim, there will be instructions on how to make an application"

src/main/java/uk/gov/hmcts/reform/pcs/ccd/domain/documentamend/DocumentAmendDetails.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.reform.pcs.ccd.domain.documentamend;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
@@ -10,10 +11,9 @@
 import lombok.NoArgsConstructor;
 import uk.gov.hmcts.ccd.sdk.api.CCD;
 import uk.gov.hmcts.reform.pcs.ccd.domain.CaseFileCategory;
-import uk.gov.hmcts.ccd.sdk.type.DynamicList;
 import uk.gov.hmcts.ccd.sdk.type.YesOrNo;
+import uk.gov.hmcts.reform.pcs.ccd.domain.DocumentSelectionDetails;
 
-import static uk.gov.hmcts.ccd.sdk.type.FieldType.DynamicRadioList;
 import static uk.gov.hmcts.ccd.sdk.type.FieldType.FixedList;
 
 @Builder
@@ -22,7 +22,7 @@
 @AllArgsConstructor
 @JsonInclude(Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.UpperCamelCaseStrategy.class)
-public class DocumentAmendDetails {
+public class DocumentAmendDetails implements DocumentSelectionDetails {
 
     @CCD(
         label = "Which folder is the document in?",
@@ -35,69 +35,6 @@ public class DocumentAmendDetails {
     @CCD(searchable = false)
     private String propertyAddressSummary;
 
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList statementsOfCaseDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList propertyDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList evidenceDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList hearingDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList ordersAndNoticeOfHearingsDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList applicationsDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList appealsDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList correspondenceDocuments;
-
-    @CCD(
-        label = "Which document do you want to amend?",
-        searchable = false,
-        typeOverride = DynamicRadioList
-    )
-    private DynamicList uncategorisedDocuments;
-
     @CCD(searchable = false)
     private YesOrNo statementsOfCaseEmpty;
 
@@ -136,4 +73,20 @@ public class DocumentAmendDetails {
 
     @CCD(searchable = false)
     private String selectedDocumentFileName;
+
+    @JsonIgnore
+    @Override
+    public void setEmptyForCategory(CaseFileCategory category, YesOrNo empty) {
+        switch (category) {
+            case STATEMENTS_OF_CASE -> statementsOfCaseEmpty = empty;
+            case PROPERTY_DOCUMENTS -> propertyDocumentsEmpty = empty;
+            case EVIDENCE -> evidenceEmpty = empty;
+            case HEARING_DOCUMENTS -> hearingDocumentsEmpty = empty;
+            case ORDERS_AND_NOTICE_OF_HEARINGS -> ordersAndNoticeOfHearingsEmpty = empty;
+            case APPLICATIONS -> applicationsEmpty = empty;
+            case APPEALS -> appealsEmpty = empty;
+            case CORRESPONDENCE -> correspondenceEmpty = empty;
+            case UNCATEGORISED_DOCUMENTS -> uncategorisedDocumentsEmpty = empty;
+        }
+    }
 }

src/main/java/uk/gov/hmcts/reform/pcs/ccd/domain/documentremoval/DocumentRemovalDetails.java

@@ -0,0 +1,135 @@
+package uk.gov.hmcts.reform.pcs.ccd.domain.documentremoval;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import uk.gov.hmcts.ccd.sdk.api.CCD;
+import uk.gov.hmcts.ccd.sdk.type.YesOrNo;
+import uk.gov.hmcts.reform.pcs.ccd.domain.CaseFileCategory;
+import uk.gov.hmcts.reform.pcs.ccd.domain.DocumentSelectionDetails;
+
+import static uk.gov.hmcts.ccd.sdk.type.FieldType.FixedList;
+import static uk.gov.hmcts.ccd.sdk.type.FieldType.TextArea;
+
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonInclude(Include.NON_NULL)
+@JsonNaming(PropertyNamingStrategies.UpperCamelCaseStrategy.class)
+public class DocumentRemovalDetails implements DocumentSelectionDetails {
+
+    @CCD(
+        label = "Which folder is the document in?",
+        searchable = false,
+        typeOverride = FixedList,
+        typeParameterOverride = "CaseFileCategory"
+    )
+    private CaseFileCategory selectedFolder;
+
+    @CCD(searchable = false)
+    private String propertyAddressSummary;
+
+    @CCD(searchable = false)
+    private YesOrNo statementsOfCaseEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo propertyDocumentsEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo evidenceEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo hearingDocumentsEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo ordersAndNoticeOfHearingsEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo applicationsEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo appealsEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo correspondenceEmpty;
+
+    @CCD(searchable = false)
+    private YesOrNo uncategorisedDocumentsEmpty;
+
+    @CCD(searchable = false)
+    private String selectedFolderId;
+
+    @CCD(searchable = false)
+    private String selectedFolderLabel;
+
+    @CCD(searchable = false)
+    private String selectedDocumentId;
+
+    @CCD(searchable = false)
+    private String selectedDocumentFileName;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String statementsOfCaseReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String propertyDocumentsReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String evidenceReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String hearingDocumentsReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String ordersAndNoticeOfHearingsReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String applicationsReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String appealsReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String correspondenceReason;
+
+    @CCD(searchable = false, typeOverride = TextArea)
+    private String uncategorisedDocumentsReason;
+
+    @JsonIgnore
+    @Override
+    public void setEmptyForCategory(CaseFileCategory category, YesOrNo empty) {
+        switch (category) {
+            case STATEMENTS_OF_CASE -> statementsOfCaseEmpty = empty;
+            case PROPERTY_DOCUMENTS -> propertyDocumentsEmpty = empty;
+            case EVIDENCE -> evidenceEmpty = empty;
+            case HEARING_DOCUMENTS -> hearingDocumentsEmpty = empty;
+            case ORDERS_AND_NOTICE_OF_HEARINGS -> ordersAndNoticeOfHearingsEmpty = empty;
+            case APPLICATIONS -> applicationsEmpty = empty;
+            case APPEALS -> appealsEmpty = empty;
+            case CORRESPONDENCE -> correspondenceEmpty = empty;
+            case UNCATEGORISED_DOCUMENTS -> uncategorisedDocumentsEmpty = empty;
+        }
+    }
+
+    @JsonIgnore
+    public String getReasonForCategory(CaseFileCategory category) {
+        return switch (category) {
+            case STATEMENTS_OF_CASE -> statementsOfCaseReason;
+            case PROPERTY_DOCUMENTS -> propertyDocumentsReason;
+            case EVIDENCE -> evidenceReason;
+            case HEARING_DOCUMENTS -> hearingDocumentsReason;
+            case ORDERS_AND_NOTICE_OF_HEARINGS -> ordersAndNoticeOfHearingsReason;
+            case APPLICATIONS -> applicationsReason;
+            case APPEALS -> appealsReason;
+            case CORRESPONDENCE -> correspondenceReason;
+            case UNCATEGORISED_DOCUMENTS -> uncategorisedDocumentsReason;
+        };
+    }
+}

src/main/java/uk/gov/hmcts/reform/pcs/ccd/entity/DocumentEntity.java

@@ -26,6 +26,7 @@
 import uk.gov.hmcts.reform.pcs.ccd.entity.respondpossessionclaim.DefendantResponseEntity;
 
 import java.time.Instant;
+import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;
@@ -103,6 +104,12 @@ public class DocumentEntity {
     @JoinColumn(name = "counter_claim_id")
     private CounterClaimEntity counterClaim;
 
+    private boolean removed;
+
+    private String removalReason;
+
+    private LocalDateTime removedAt;
+
     @PrePersist
     void prePersist() {
         if (submittedDate == null) {