From 50c1397db20031eeb07ba81cd89dac1f2365d9ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marcin=20Wo=C5=BAniak?= <y0rune@aol.com>
Date: Fri, 20 Nov 2020 14:50:07 +0100
Subject: [PATCH] Added docs into repositories
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Marcin Woźniak <y0rune@aol.com>
---
 .../repositories/AssignmentRepository.java          |  7 +++++++
 .../repositories/CommisionRepository.java           | 13 +++++++++++++
 .../plannaplan/repositories/CourseRepository.java   |  7 +++++++
 .../plannaplan/repositories/GroupRepository.java    | 13 +++++++++++++
 .../plannaplan/repositories/LecturerRepository.java |  7 +++++++
 5 files changed, 47 insertions(+)

diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/AssignmentRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/AssignmentRepository.java
index 929525b..9d2f723 100755
--- a/buisnesslogic/src/main/java/com/plannaplan/repositories/AssignmentRepository.java
+++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/AssignmentRepository.java
@@ -9,6 +9,13 @@ import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+/**
+ *  AssignmentRepository.getByCommision:
+ *      Return list of:
+ *      SELECT * FROM Assignment WHERE commision_id = i .
+ * 
+ *      Where i, ?1 are equale to variables. 
+ */
 @Repository
 public interface AssignmentRepository extends JpaRepository<Assignment, Long> {
 
diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/CommisionRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/CommisionRepository.java
index 4f86813..2778f06 100755
--- a/buisnesslogic/src/main/java/com/plannaplan/repositories/CommisionRepository.java
+++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/CommisionRepository.java
@@ -9,6 +9,19 @@ import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+/**
+ *  CommisionRepository.getUsers:
+ *      Return list of:
+ *      SELECT * FROM Commision WHERE owner_id = i .
+ * 
+ *      Where i, ?1 are equale to variables. 
+ * 
+ *  CommisionRepository.getNewestCommision
+ *      Return list of:
+ *      SELECT * FROM Commision WHERE owner_id = i Order by commisionDate desc.
+ * 
+ *      Where i, ?1 are equale to variables.      
+ */
 @Repository
 public interface CommisionRepository extends JpaRepository<Commision, Long> {
     @Query("FROM Commision WHERE owner_id = ?1")
diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/CourseRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/CourseRepository.java
index 78027e3..ee72fc9 100755
--- a/buisnesslogic/src/main/java/com/plannaplan/repositories/CourseRepository.java
+++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/CourseRepository.java
@@ -9,6 +9,13 @@ import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+/**
+ *  CourseRepository.findByName:
+ *      Return list of:
+ *      SELECT * FROM Course WHERE name = i .
+ * 
+ *      Where i, ?1 are equale to variables. 
+ */
 @Repository
 public interface CourseRepository extends JpaRepository<Course, Long> {
     @Query("FROM Course WHERE name = ?1")
diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/GroupRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/GroupRepository.java
index b1abbeb..62c303b 100755
--- a/buisnesslogic/src/main/java/com/plannaplan/repositories/GroupRepository.java
+++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/GroupRepository.java
@@ -10,6 +10,19 @@ import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+/**
+ *  GroupRepository.find:
+ *      Return list of:
+ *      SELECT * FROM Groups WHERE time = i AND room = j AND capacity = k .
+ * 
+ *      Where i, j, k, ?1, ?2, ?3 are equale to variables. 
+ * 
+ *  GroupRepository.getByCourse:
+ *      Return list of:
+ *      SELECT * FROM Groups WHERE course_id = i .
+ * 
+ *      Where i, ?1 are equale to variables. 
+ */
 @Repository
 public interface GroupRepository extends JpaRepository<Groups, Long> {
     @Query("FROM Groups WHERE time = ?1 AND room = ?2 AND capacity = ?3")
diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/LecturerRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/LecturerRepository.java
index d3bac97..d179c81 100755
--- a/buisnesslogic/src/main/java/com/plannaplan/repositories/LecturerRepository.java
+++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/LecturerRepository.java
@@ -9,6 +9,13 @@ import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
+/**
+ *  LecturerRepository.find:
+ *      Return list of:
+ *      SELECT * FROM Lecturer WHERE title = i AND name = j AND surname = k.
+ * 
+ *      Where i, j, k, ?1, ?2, ?3 are equale to variables. 
+ */
 @Repository
 public interface LecturerRepository extends JpaRepository<Lecturer, Long> {
     @Query("FROM Lecturer WHERE title = ?1 AND name = ?2 AND surname = ?3")