From ee2685cd45fb22b047dffee6d675a093d10b183a Mon Sep 17 00:00:00 2001
From: Samuel Wolff <Samuel.Wolff@edu.bib.de>
Date: Fri, 26 Jan 2024 08:22:04 +0100
Subject: [PATCH] JavaDoc-Schnittstelle

---
 .../RestAPISchnittstelle/RestApiClient.java   | 37 ++++++++++++++++++-
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/src/main/java/RestAPISchnittstelle/RestApiClient.java b/src/main/java/RestAPISchnittstelle/RestApiClient.java
index 7e9cc2c..6115f1b 100644
--- a/src/main/java/RestAPISchnittstelle/RestApiClient.java
+++ b/src/main/java/RestAPISchnittstelle/RestApiClient.java
@@ -17,8 +17,6 @@ import com.google.gson.*;
 import javafx.scene.control.Alert;
 
 /**
- * noch nicht getestet
- * TODO FERTIG MACHEN
  * @author Samuel Wolff
  */
 public class RestApiClient implements IRestAPI{
@@ -53,6 +51,7 @@ public class RestApiClient implements IRestAPI{
 	 * Methode für einen Get-Aufruf. Ruft alle Elemente einer Tabelle auf.
 	 *
 	 * @param controllerName Name des aufzurufenden Controllers
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public String get(String controllerName) {
@@ -90,6 +89,7 @@ public class RestApiClient implements IRestAPI{
 	 *
 	 * @param controllerName Name des aufzurufenden Controllers
 	 * @param id Id der Aufzurufenden Zeile
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public String get(String controllerName, int id) {
@@ -125,11 +125,14 @@ public class RestApiClient implements IRestAPI{
 	}
 
 	/**
+	 * --DEPRECATED--
 	 * Methode für einen Get-Aufruf. Ruft ein spezielles Element auf.
 	 *
 	 * @param controllerName Name des aufzurufenden Controllers
 	 * @param id Id der Aufzurufenden Zeile
 	 * @param bezahlt TODO Warum ist das hier?
+	 * @deprecated
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public String get(String controllerName, int id, boolean bezahlt) {
@@ -162,6 +165,13 @@ public class RestApiClient implements IRestAPI{
 		}
 	}
 
+	/***
+	 * Ein gefilterter Get Aufruf
+	 * @param controllerName
+	 * @param params
+	 * @return
+	 * @author Sven Alteköster
+	 */
 	@Override
 	public String get(String controllerName, String[] params) {
 		String ende = "";
@@ -206,6 +216,7 @@ public class RestApiClient implements IRestAPI{
 	 * @param controllerName Name des aufzurufenden Controllers.
 	 * @param id Id des zu änderenden Eintrags.
 	 * @param jsonData JsonString mit den neuen Daten.
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public void put(String controllerName, int id, String jsonData) {
@@ -242,6 +253,7 @@ public class RestApiClient implements IRestAPI{
 	 *
 	 * @param controllerName Name des aufzurufenden Controllers.
 	 * @param jsonData JsonString mit den Daten des Eintrags.
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public void post(String controllerName, String jsonData) {
@@ -279,6 +291,7 @@ public class RestApiClient implements IRestAPI{
 	 *
 	 * @param controllerName Name des aufzurufenden Controllers
 	 * @param id Id des zu löschenden Eintrags.
+	 * @author Samuel Wolff
 	 */
 	@Override
 	public void delete(String controllerName, int id) {
@@ -311,6 +324,12 @@ public class RestApiClient implements IRestAPI{
 		}
 	}
 
+	/***
+	 * Holt die nöchste Autoinkrement Id für den mitgegebenen Controller aus der Datenbank
+	 * @param controllerName
+	 * @return
+	 * @author Samuel Wolff
+	 */
 	public int nextId(String controllerName){
 		URI apiUri = URI.create(String.format("%s/%s/nextId", urlBase, controllerName));
 
@@ -353,6 +372,7 @@ public class RestApiClient implements IRestAPI{
 	 *
 	 * @param credentials Die Anmeldedaten in Json-String form
 	 * @return True oder false, je nach Erfolg des Anmeldeversuchs
+	 * @author Samuel Wolff
 	 */
 	public boolean anmeldeVersuch(String credentials){
 
@@ -409,6 +429,7 @@ public class RestApiClient implements IRestAPI{
 	 *
 	 * @param datum Das angeforderte Datum in String Form (YYYY-MM-DD)
 	 * @return Ein Tagesplan Objekt mit allen Gerichten
+	 * @author Samuel Wolff
 	 */
 	public Tagesplan getGerichteOnTag(String datum){
 
@@ -461,6 +482,13 @@ public class RestApiClient implements IRestAPI{
 		}
 	}
 
+	/**
+	 * Holt die Id des Gerichtes mit dem mitgegebenen Namen an einem mitgegebenen Tag und gibt sie zurück
+	 * @param name
+	 * @param datum
+	 * @return
+	 * @author Samuel Wolff
+	 */
 	public int getGerichtIdOnTag(String name, String datum){
 
 		URI apiUri = URI.create(String.format("%s/Tagesplan/getGerichtIdOnTag?name=%s&datum=%s", urlBase, name, datum));
@@ -493,6 +521,11 @@ public class RestApiClient implements IRestAPI{
 		}
 	}
 
+	/**
+	 * Löscht ein Gericht mit der mitgebenen Id aus der Datenbank
+	 * @param id
+	 * @author Samuel Wolff
+	 */
 	public void deleteGericht(int id){
 		URI apiUri = URI.create(String.format("%s/Tagesplan/%d", urlBase, id));
 		System.out.println(apiUri);