JavaDoc für Variantenermittlung

3 files changed, 28 insertions, 0 deletions

diff --git a/src/main/java/DNPM/dto/Variant.java b/src/main/java/DNPM/dto/Variant.java
index f8d25c1..d3fab9e 100644
--- a/src/main/java/DNPM/dto/Variant.java
+++ b/src/main/java/DNPM/dto/Variant.java
@@ -4,6 +4,11 @@ import de.itc.onkostar.api.Procedure;
 
 import java.util.Optional;
 
+/**
+ * Ein Auszug der Variante aus dem NGS-Bericht zur Übertragung an das Frontend zur Auswahl der stützenden molekularen Alteration
+ *
+ * @since 0.2.0
+ */
 public class Variant {
     private final Integer id;
 
@@ -49,6 +54,11 @@ public class Variant {
         return pathogenitaetsklasse;
     }
 
+    /**
+     * Erstellt ein Optional einer Variante aus einer Prozedur
+     * @param procedure Die zu verwendende Prozedur
+     * @return Das Optional, wenn die Prozedur verwendet werden kann, ansonsten ein leeres Optional
+     */
     public static Optional<Variant> fromProcedure(Procedure procedure) {
         if (!"OS.Molekulargenetische Untersuchung".equals(procedure.getFormName())) {
             return Optional.empty();
diff --git a/src/main/java/DNPM/services/molekulargenetik/MolekulargenetikFormService.java b/src/main/java/DNPM/services/molekulargenetik/MolekulargenetikFormService.java
index 5af03b2..60cfaf2 100644
--- a/src/main/java/DNPM/services/molekulargenetik/MolekulargenetikFormService.java
+++ b/src/main/java/DNPM/services/molekulargenetik/MolekulargenetikFormService.java
@@ -5,8 +5,16 @@ import de.itc.onkostar.api.Procedure;
 
 import java.util.List;
 
+/**
+ * Schnittstellenbeschreibung für Methoden zum Formular "OS.Molekulargenetik"
+ */
 public interface MolekulargenetikFormService {
 
+    /**
+     * Ermittelt alle (unterstützten) Varianten zur Prozedur eines Formulars "OS.Molekulargenetik"
+     * @param procedure Die Prozedur zum Formular "OS.Molekulargenetik"
+     * @return Die unterstützten Varianten oder eine leere Liste, wenn keine Varianten gefunden wurden.
+     */
     List<Variant> getVariants(Procedure procedure);
 
 }
diff --git a/src/main/java/DNPM/services/molekulargenetik/OsMolekulargenetikFormService.java b/src/main/java/DNPM/services/molekulargenetik/OsMolekulargenetikFormService.java
index 8e673d7..06ab9d2 100644
--- a/src/main/java/DNPM/services/molekulargenetik/OsMolekulargenetikFormService.java
+++ b/src/main/java/DNPM/services/molekulargenetik/OsMolekulargenetikFormService.java
@@ -10,6 +10,16 @@ import java.util.stream.Collectors;
 
 public class OsMolekulargenetikFormService implements MolekulargenetikFormService {
 
+    /**
+     * Ermittelt alle (unterstützten) Varianten zur Prozedur eines Formulars "OS.Molekulargenetik"
+     * Unterstützte Varianten sind:
+     * <uL>
+     *     <li>Einfache Variante
+     *     <li>CNV
+     *     <li>Fusion
+     * @param procedure Die Prozedur zum Formular "OS.Molekulargenetik"
+     * @return Die unterstützten Varianten oder eine leere Liste, wenn keine Varianten gefunden wurden.
+     */
     @Override
     @PersonPoolSecured
     public List<Variant> getVariants(Procedure procedure) {