Merge pull request SORMAS-Foundation#3528 from hzi-braunschweig/feat-3463-external-journal-javadoc

SORMAS-Foundation#3463 update ExternalJournalService javadoc

Author: vlad-ciucescu

sormas-backend/src/main/java/de/symeda/sormas/backend/externaljournal/ExternalJournalService.java

@@ -48,6 +48,15 @@
 import de.symeda.sormas.backend.common.ConfigFacadeEjb;
 import de.symeda.sormas.backend.person.PersonFacadeEjb;
 
+/**
+ * This service provides methods for communicating with external symptom journals.
+ * <br>
+ * Currently, 2 symptom journals are supported: PIA and CLIMEDO.
+ * <br>
+ * Methods containing <code>symptomJournal</code> refer to PIA.
+ * <br>
+ * Methods containing <code>patientDiary</code> refer to CLIMEDO.
+ */
 @Stateless
 @LocalBean
 public class ExternalJournalService {
@@ -314,8 +323,9 @@ private Invocation.Builder getExternalDataPersonInvocationBuilder(String personU
 	}
 
 	/**
-	 * Check whether a person has valid data in order to be registered in the patient diary
-	 * 
+	 * Check whether a person has valid data in order to be registered in the patient diary.
+	 * NOTE: since CLIMEDO is only used in Germany, only German numbers are considered valid at the moment
+	 *
 	 * @param person
 	 *            the person to validate
 	 * @return the result of the validation