💡cleanup and minor enhancements

Author: Pa-Touche

sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenIndexDto.java

@@ -23,7 +23,6 @@ public class SurveyTokenIndexDto extends PseudonymizableIndexDto {
 
 	public static final String I18N_PREFIX = "SurveyToken";
 	private static final long serialVersionUID = 4358173798026207265L;
-
 	public static final String TOKEN = "token";
 	public static final String ASSIGNED_CASE_UUID = "assignedCaseUuid";
 	public static final String ASSIGNEMENT_DATE = "assignmentDate";
@@ -41,6 +40,7 @@ public class SurveyTokenIndexDto extends PseudonymizableIndexDto {
 	private final String generatedDocumentUuid;
 	private final String generatedDocumentName;
 	private final String generatedDocumentMimeType;
+	private final String externalRespondentId;
 
 	public SurveyTokenIndexDto(
 		String uuid,
@@ -54,7 +54,8 @@ public SurveyTokenIndexDto(
 		String generatedDocumentUuid,
 		String generatedDocumentName,
 		String generatedDocumentMimeType,
-		Date generatedDocumentDate) {
+		Date generatedDocumentDate,
+		String externalRespondentId) {
 		super(uuid);
 		this.surveyUuid = surveyUuid;
 		this.surveyName = surveyName;
@@ -67,6 +68,7 @@ public SurveyTokenIndexDto(
 		this.generatedDocumentName = generatedDocumentName;
 		this.generatedDocumentMimeType = generatedDocumentMimeType;
 		this.responseReceivedDate = generatedDocumentDate;
+		this.externalRespondentId = externalRespondentId;
 	}
 
 	public String getSurveyUuid() {
@@ -116,4 +118,8 @@ public String getGeneratedDocumentMimeType() {
 	public Date getResponseReceivedDate() {
 		return responseReceivedDate;
 	}
+
+	public String getExternalRespondentId() {
+		return externalRespondentId;
+	}
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/externalmessage/ExternalMessageFacadeEjb.java

@@ -22,6 +22,7 @@
 import java.util.Date;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.ExecutionException;
 import java.util.stream.Collectors;
@@ -136,6 +137,8 @@
 	UserRight._EXTERNAL_MESSAGE_DOCTOR_DECLARATION_VIEW })
 public class ExternalMessageFacadeEjb implements ExternalMessageFacade {
 
+	public static final String SURVEY_PERIOD_INTERVAL_HOURS = "SURVEY_PERIOD_INTERVAL_HOURS";
+
 	private final Logger logger = LoggerFactory.getLogger(getClass());
 
 	@PersistenceContext(unitName = ModelConstants.PERSISTENCE_UNIT_NAME)
@@ -327,9 +330,10 @@ public ExternalMessageDto saveAndProcessLabmessage(@Valid ExternalMessageDto lab
 	public List<ExternalMessageDto> saveAndProcessSurveyResponses(Date since) {
 
 		if (since == null) {
-			// TODO: configurable date value.
-			logger.error("Since date should be configurable");
-			since = DateHelper.addDays(new Date(), -7);
+			int hoursRange =
+				Integer.parseInt(Optional.ofNullable(systemConfigurationValueFacade.getValue(SURVEY_PERIOD_INTERVAL_HOURS)).orElse("168"));
+
+			since = DateHelper.addSeconds(new Date(), -(hoursRange * 3600));
 		}
 
 		ExternalMessageAdapterFacade externalLabResultsFacade = getSurveyExternalMessageFacade();

sormas-backend/src/main/java/de/symeda/sormas/backend/json/ObjectMapperProvider.java

@@ -24,6 +24,9 @@
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
+/**
+ * Permits unified access to a pre-configured {@link ObjectMapper} instance.
+ */
 public final class ObjectMapperProvider {
 
 	private static final Logger logger = LoggerFactory.getLogger(ObjectMapperProvider.class);

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/BusinessDtoFacade.java

@@ -24,6 +24,9 @@
 import de.symeda.sormas.backend.immunization.ImmunizationFacadeEjb;
 import de.symeda.sormas.backend.person.PersonFacadeEjb;
 
+/**
+ * Meant as single entry point for usages were multiple Business DTOs must be fetched or saved.
+ */
 @ApplicationScoped
 public class BusinessDtoFacade {
 
@@ -99,24 +102,58 @@ public CaseDataDto getCaseDataDto(String caseUuid) {
 			.orElseThrow(() -> new IllegalStateException(String.format("No CaseDataDto found for [%s]", caseUuid)));
 	}
 
+	/**
+	 * Meant for creational purposes.
+	 * 
+	 * @param entityClass
+	 *            target class
+	 * @param caseDataDto
+	 *            linked case
+	 * @return DTO if found.
+	 * @param <T>
+	 *            types
+	 */
 	@Nullable
 	public <T extends EntityDto> T fetch(@NotNull Class<T> entityClass, CaseDataDto caseDataDto) {
 		return Optional.ofNullable((Function<CaseDataDto, T>) dtoRetrieverDictionary.get(entityClass))
 			.orElseThrow(() -> new IllegalStateException(String.format("No fetch function defined for: [%s]", entityClass)))
 			.apply(caseDataDto);
 	}
 
+	/**
+	 * Meant for display purposes.
+	 * 
+	 * @param i18nName
+	 *            DtoPrefix per example {@link PersonDto#I18N_PREFIX}.
+	 * @param caseDataDto
+	 *            linked case.
+	 * @return entity dto if found.
+	 */
 	@Nullable
 	public List<? extends EntityDto> fetchByI18nName(@NotNull String i18nName, CaseDataDto caseDataDto) {
 		return Optional.ofNullable(dtoRetrieverByI18nDictionary.get(i18nName))
 			.orElseThrow(() -> new IllegalStateException(String.format("No fetch function defined for: [%s]", i18nName)))
 			.apply(caseDataDto);
 	}
 
+	/**
+	 * For displaying purposes what purposes can be retrieved.
+	 * 
+	 * @return prefixes that can be fetched through their I18n Prefix.
+	 */
 	public Set<String> fetchablePrefixes() {
 		return dtoRetrieverByI18nDictionary.keySet();
 	}
 
+	/**
+	 * Single entry for saving a business DTO.
+	 * 
+	 * @param entityDto
+	 *            business DTO
+	 * @return saved DTO.
+	 * @param <T>
+	 *            type
+	 */
 	public <T extends EntityDto> T save(@NotNull EntityDto entityDto) {
 		Class<? extends EntityDto> entityDtoClass = entityDto.getClass();
 

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/DataPatcherImpl.java

@@ -237,7 +237,6 @@ private boolean anyFieldPatchedWithPrefix(Map<String, Object> validPatchDictiona
 			.collect(CollectorUtils.toNullSafeMap(de.symeda.sormas.api.patch.SinglePatchResult::getFieldName, fct));
 	}
 
-	// TODO: make usable for external use
 	private @NotNull de.symeda.sormas.api.patch.SinglePatchResult valueMappingResult(
 		Tuple<String, Tuple<DataPatchFailureCause, Object>> entry,
 		Disease disease,
@@ -314,7 +313,6 @@ private DataPatchFailureCause extractFailureCause(Tuple<String, Tuple<DataPatchF
 		return entry.getSecond().getFirst();
 	}
 
-	// TODO: make usable for external use
 	private Optional<de.symeda.sormas.api.patch.SinglePatchResult> fieldMappingResult(
 		Tuple<String, Tuple<DataPatchFailureCause, Object>> entry,
 		Disease disease,

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/PathFailureCause.java

@@ -5,6 +5,9 @@
 import de.symeda.sormas.api.patch.DataPatchFailureCause;
 import de.symeda.sormas.api.patch.partial_retrieval.PartialRetrievalFailureCause;
 
+/**
+ * Occurs when trying to access path.
+ */
 public enum PathFailureCause {
 
 	INVALID_PATH_FORMAT(DataPatchFailureCause.INVALID_PATH_FORMAT, PartialRetrievalFailureCause.INVALID_PATH_FORMAT),

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/alias/PathAliasHelper.java

@@ -32,8 +32,6 @@ public class PathAliasHelper {
 
 	private final static Logger logger = LoggerFactory.getLogger(PathAliasHelper.class);
 
-	// TODO: define configurable additional aliases ?
-
 	public static final Map<String, String> DEFAULT_ALIAS_DICTIONARY = buildDefaultAliasDictionary();
 
 	public static final Map<String, Set<String>> DEFAULT_FORBIDDEN_ALIASES_DICTIONARY =
@@ -78,7 +76,6 @@ public Tuple<String, PathFailureCause> resolveAlias(String pathWithPotentialAlia
 			return tupleWithFailure(PathFailureCause.FORBIDDEN_NON_UNIQUE_ALIAS);
 		}
 
-		// TODO: refactor this
 		String pathWithFixedRootObjectReferences = REFERENCE_TO_ROOT_DICTIONARY.values()
 			.stream()
 			.reduce(

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/mapping/impl/fieldmapper/PersonBirthDateFieldMapper.java

@@ -47,11 +47,9 @@ public Optional<DataPatchFailure> map(FieldPatchRequest request) {
 
 		Date birthDate = result.getData();
 
-		// TODO: remove duplication.
 		Calendar calendar = Calendar.getInstance();
 		calendar.setTime(birthDate);
 		int dayOfMonth = calendar.get(Calendar.DAY_OF_MONTH);
-		// In calendar API months are indexed from 0 @see https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html#MONTH
 		int birthdateMonth = calendar.get(Calendar.MONTH) + 1;
 		int year = calendar.get(Calendar.YEAR);
 

sormas-backend/src/main/java/de/symeda/sormas/backend/patch/mapping/impl/fieldmapper/PersonContactDetailsFieldMapper.java

@@ -25,6 +25,9 @@
 import de.symeda.sormas.api.person.PhoneNumberType;
 import de.symeda.sormas.api.utils.DataHelper;
 
+/**
+ * Allows to set the phone number or email contact info of a person with within a single mapper.
+ */
 @ApplicationScoped
 public class PersonContactDetailsFieldMapper implements FieldCustomMapper {