Task 13886 customizable fields metadata values handling

sormas-api/src/main/java/de/symeda/sormas/api/FacadeProvider.java

@@ -39,6 +39,8 @@
 import de.symeda.sormas.api.clinicalcourse.ClinicalVisitFacade;
 import de.symeda.sormas.api.contact.ContactFacade;
 import de.symeda.sormas.api.customizableenum.CustomizableEnumFacade;
+import de.symeda.sormas.api.customizablefield.CustomizableFieldMetadataFacade;
+import de.symeda.sormas.api.customizablefield.CustomizableFieldValueFacade;
 import de.symeda.sormas.api.dashboard.DashboardFacade;
 import de.symeda.sormas.api.dashboard.adverseeventsfollowingimmunization.AefiDashboardFacade;
 import de.symeda.sormas.api.dashboard.sample.SampleDashboardFacade;
@@ -508,6 +510,14 @@ public static CustomizableEnumFacade getCustomizableEnumFacade() {
 		return get().lookupEjbRemote(CustomizableEnumFacade.class);
 	}
 
+	public static CustomizableFieldMetadataFacade getCustomizableFieldMetadataFacade() {
+		return get().lookupEjbRemote(CustomizableFieldMetadataFacade.class);
+	}
+
+	public static CustomizableFieldValueFacade getCustomizableFieldValueFacade() {
+		return get().lookupEjbRemote(CustomizableFieldValueFacade.class);
+	}
+
 	public static InfoFacade getInfoFacade() {
 		return get().lookupEjbRemote(InfoFacade.class);
 	}

sormas-api/src/main/java/de/symeda/sormas/api/common/DeletableEntityType.java

@@ -30,5 +30,7 @@ public enum DeletableEntityType {
 	PATHOGEN_TEST,
 	ENVIRONMENT,
 	ENVIRONMENT_SAMPLE,
-	SELF_REPORT;
+	SELF_REPORT,
+	CUSTOMIZABLE_FIELD_METADATA,
+	CUSTOMIZABLE_FIELD_VALUE;
 }

sormas-api/src/main/java/de/symeda/sormas/api/customizablefield/CustomizableFieldContext.java

@@ -0,0 +1,67 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2026 SORMAS Foundation gGmbH
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api.customizablefield;
+
+import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.caze.CaseDataDto;
+import de.symeda.sormas.api.epidata.EpiDataDto;
+import de.symeda.sormas.api.exposure.ExposureDto;
+
+/**
+ * Defines supported customizable field contexts and links them to existing
+ * SORMAS DTO classes. Contexts must reference real DTOs; defining a custom
+ * field for a non-existent DTO does not make sense.
+ */
+public enum CustomizableFieldContext {
+
+	CASE(CaseDataDto.class),
+	EPIDATA(EpiDataDto.class),
+	EXPOSURE(ExposureDto.class);
+
+	// add other contexts here
+
+	private final String contextClassName;
+
+	CustomizableFieldContext(Class<? extends EntityDto> dtoClass) {
+		this.contextClassName = dtoClass.getName();
+	}
+
+	public String getContextClassName() {
+		return contextClassName;
+	}
+
+	public static CustomizableFieldContext fromDtoClass(Class<? extends EntityDto> dtoClass) {
+		return fromDtoClassName(dtoClass.getName());
+	}
+
+	public static CustomizableFieldContext fromDtoClassName(String dtoClassName) {
+		Class<?> rawClass;
+		try {
+			rawClass = Class.forName(dtoClassName);
+		} catch (ClassNotFoundException e) {
+			throw new IllegalArgumentException("Unknown context DTO: " + dtoClassName, e);
+		}
+		if (!EntityDto.class.isAssignableFrom(rawClass)) {
+			throw new IllegalArgumentException("Context class is not an EntityDto: " + dtoClassName);
+		}
+		for (CustomizableFieldContext context : values()) {
+			if (context.contextClassName.equals(dtoClassName)) {
+				return context;
+			}
+		}
+		throw new IllegalArgumentException("Unknown context DTO: " + dtoClassName);
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/customizablefield/CustomizableFieldCustomProperties.java

@@ -0,0 +1,58 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2026 SORMAS Foundation gGmbH
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api.customizablefield;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * Typed representation of the {@code customProperties} JSON column on
+ * {@link CustomizableFieldMetadataDto}.
+ * <p>
+ * Field-type-specific configuration lives here:
+ * <ul>
+ * <li><b>options</b> – selectable string values used by
+ * {@link CustomizableFieldType#COMBOBOX},
+ * {@link CustomizableFieldType#CHECKBOX_LIST}, and
+ * {@link CustomizableFieldType#RADIO_BUTTON_LIST}.</li>
+ * </ul>
+ * Additional properties can be added here as the feature grows without
+ * touching the database schema (the whole object is stored as a single
+ * {@code jsonb} column).
+ */
+public class CustomizableFieldCustomProperties implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * The list of selectable option values for list-type fields
+     * ({@code COMBOBOX}, {@code CHECKBOX_LIST}, {@code RADIO_BUTTON_LIST}).
+     * Each entry is the raw stored string value (not a display label).
+     */
+    private List<String> options;
+
+    public CustomizableFieldCustomProperties() {
+        // Required for JSON deserialization.
+    }
+
+    public List<String> getOptions() {
+        return options;
+    }
+
+    public void setOptions(List<String> options) {
+        this.options = options;
+    }
+}

sormas-api/src/main/java/de/symeda/sormas/api/customizablefield/CustomizableFieldGroup.java

@@ -0,0 +1,117 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2026 SORMAS Foundation gGmbH
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api.customizablefield;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Defines UI groups for customizable fields, scoped to a specific {@link CustomizableFieldContext}.
+ * <p>
+ * Each group has a stable string {@link #key} that is used as:
+ * <ul>
+ * <li>the value stored in the database;</li>
+ * <li>the Vaadin layout location ID when embedding a {@code CustomizableFieldsGroup} component.</li>
+ * </ul>
+ * <p>
+ * To add a new group, append an enum value with the owning context and a unique, stable key.
+ * The key must not be changed after data has been stored against it.
+ */
+public enum CustomizableFieldGroup {
+
+	// ---- CASE groups --------------------------------------------------------
+	CASE_DATA_GENERAL(CustomizableFieldContext.CASE, "caseDataGeneral"),
+	CASE_DATA_CLASSIFICATION(CustomizableFieldContext.CASE, "caseDataClassification"),
+	CASE_DATA_INVESTIGATION(CustomizableFieldContext.CASE, "caseDataInvestigation"),
+	CASE_DATA_IDENTIFIERS(CustomizableFieldContext.CASE, "caseDataIdentifiers"),
+	CASE_DATA_DISEASE(CustomizableFieldContext.CASE, "caseDataDisease"),
+	CASE_DATA_REINFECTION(CustomizableFieldContext.CASE, "caseDataReinfection"),
+	CASE_DATA_OUTCOME(CustomizableFieldContext.CASE, "caseDataOutcome"),
+	CASE_DATA_SEQUELAE(CustomizableFieldContext.CASE, "caseDataSequelae"),
+	CASE_DATA_JURISDICTION(CustomizableFieldContext.CASE, "caseDataJurisdiction"),
+	CASE_DATA_PLACE_OF_STAY(CustomizableFieldContext.CASE, "caseDataPlaceOfStay"),
+	CASE_DATA_QUARANTINE(CustomizableFieldContext.CASE, "caseDataQuarantine"),
+	CASE_DATA_REPORT_GEO(CustomizableFieldContext.CASE, "caseDataReportGeo"),
+	CASE_DATA_HEALTH_CONDITIONS(CustomizableFieldContext.CASE, "caseDataHealthConditions"),
+	CASE_DATA_DIAGNOSTIC(CustomizableFieldContext.CASE, "caseDataDiagnostic"),
+	CASE_DATA_MEDICAL_INFORMATION(CustomizableFieldContext.CASE, "caseDataMedicalInformation"),
+	CASE_DATA_VACCINATION(CustomizableFieldContext.CASE, "caseDataVaccination"),
+	CASE_DATA_CLINICIAN_NOTIFICATION(CustomizableFieldContext.CASE, "caseDataClinicianNotification"),
+	CASE_DATA_CONTACT_TRACING(CustomizableFieldContext.CASE, "caseDataContactTracing"),
+
+	// ---- EPIDATA groups -----------------------------------------------------
+	EPIDATA_EXPOSURE_INVESTIGATION(CustomizableFieldContext.EPIDATA, "exposureInvestigation"),
+	EPIDATA_ACTIVITY_AS_CASE(CustomizableFieldContext.EPIDATA, "activityAsCase"),
+	EPIDATA_CONTACT_WITH_SOURCE_CASE(CustomizableFieldContext.EPIDATA, "contactWithSourceCase"),
+
+	// ---- EXPOSURE groups ----------------------------------------------------
+	EXPOSURE_DETAILS(CustomizableFieldContext.EXPOSURE, "exposureDetails"),
+	EXPOSURES_GENERAL(CustomizableFieldContext.EXPOSURE, "exposuresGeneral"),
+	LOCATION_GENERAL(CustomizableFieldContext.EXPOSURE, "locationGeneral");
+
+	private final CustomizableFieldContext context;
+	/**
+	 * Stable key stored in the database and used as the Vaadin layout location ID.
+	 */
+	private final String key;
+
+	CustomizableFieldGroup(CustomizableFieldContext context, String key) {
+		this.context = context;
+		this.key = key;
+	}
+
+	/**
+	 * The {@link CustomizableFieldContext} this group belongs to.
+	 */
+	public CustomizableFieldContext getContext() {
+		return context;
+	}
+
+	/**
+	 * Stable string key used as the database-stored value and as the Vaadin layout location ID.
+	 */
+	public String getKey() {
+		return key;
+	}
+
+	/**
+	 * Returns all groups that belong to the given context.
+	 */
+	public static List<CustomizableFieldGroup> getGroupsForContext(CustomizableFieldContext context) {
+		List<CustomizableFieldGroup> result = new ArrayList<>();
+		for (CustomizableFieldGroup group : values()) {
+			if (group.context == context) {
+				result.add(group);
+			}
+		}
+		return result;
+	}
+
+	/**
+	 * Looks up a group by its stable {@link #key}, returning {@code null} if not found.
+	 */
+	public static CustomizableFieldGroup fromKey(String key) {
+		if (key == null) {
+			return null;
+		}
+		for (CustomizableFieldGroup group : values()) {
+			if (group.key.equals(key)) {
+				return group;
+			}
+		}
+		return null;
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/customizablefield/CustomizableFieldMetadataCriteria.java

@@ -0,0 +1,68 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2026 SORMAS Foundation gGmbH
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api.customizablefield;
+
+import de.symeda.sormas.api.utils.IgnoreForUrl;
+import de.symeda.sormas.api.utils.criteria.BaseCriteria;
+
+/**
+ * Criteria for filtering customizable field metadata in admin views.
+ */
+public class CustomizableFieldMetadataCriteria extends BaseCriteria {
+
+    private static final long serialVersionUID = 1L;
+
+    private String freeTextFilter;
+    private CustomizableFieldContext contextClass;
+    private CustomizableFieldType fieldType;
+    private Boolean active;
+
+    public String getFreeTextFilter() {
+        return freeTextFilter;
+    }
+
+    public CustomizableFieldMetadataCriteria freeTextFilter(String freeTextFilter) {
+        this.freeTextFilter = freeTextFilter;
+        return this;
+    }
+
+    @IgnoreForUrl
+    public CustomizableFieldContext getContextClass() {
+        return contextClass;
+    }
+
+    public void setContextClass(CustomizableFieldContext contextClass) {
+        this.contextClass = contextClass;
+    }
+
+    @IgnoreForUrl
+    public CustomizableFieldType getFieldType() {
+        return fieldType;
+    }
+
+    public void setFieldType(CustomizableFieldType fieldType) {
+        this.fieldType = fieldType;
+    }
+
+    @IgnoreForUrl
+    public Boolean getActive() {
+        return active;
+    }
+
+    public void setActive(Boolean active) {
+        this.active = active;
+    }
+}