From af8e2ced288a2bcec3568eb6c55372eaba1acb29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wo=C5=BAniak?= Date: Fri, 20 Nov 2020 13:20:44 +0100 Subject: [PATCH] Added docs into services --- .../main/java/com/plannaplan/services/AssignmentService.java | 4 ++++ .../main/java/com/plannaplan/services/CommisionService.java | 4 ++++ .../java/com/plannaplan/services/ConfiguratorService.java | 3 +++ .../src/main/java/com/plannaplan/services/CourseService.java | 4 ++++ .../src/main/java/com/plannaplan/services/GroupService.java | 4 ++++ .../main/java/com/plannaplan/services/LecturerService.java | 3 +++ .../src/main/java/com/plannaplan/services/UserService.java | 3 +++ 7 files changed, 25 insertions(+) diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/AssignmentService.java b/buisnesslogic/src/main/java/com/plannaplan/services/AssignmentService.java index 370b545..162b61e 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/AssignmentService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/AssignmentService.java @@ -9,6 +9,10 @@ import com.plannaplan.repositories.AssignmentRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of Assignment which can save assignments, diplay assignments, get ammount of assigments. + */ + @Service public class AssignmentService { @Autowired diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/CommisionService.java b/buisnesslogic/src/main/java/com/plannaplan/services/CommisionService.java index 96ebd69..b22586c 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/CommisionService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/CommisionService.java @@ -10,6 +10,10 @@ import com.plannaplan.repositories.CommisionRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of CommisionService which can save commision, get user's commisions, get newest user's commision, get ammount of commisions. + */ + @Service public class CommisionService { @Autowired diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/ConfiguratorService.java b/buisnesslogic/src/main/java/com/plannaplan/services/ConfiguratorService.java index 422a646..e0fa31c 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/ConfiguratorService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/ConfiguratorService.java @@ -8,6 +8,9 @@ import org.springframework.stereotype.Component; import com.plannaplan.configutils.*; +/** + * FileReader is used for reading xls file from input stream. + */ @Component public class ConfiguratorService { diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java b/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java index 125abf8..e093f29 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java @@ -9,6 +9,10 @@ import com.plannaplan.repositories.CourseRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of CourseService which can get(Course By Name, All Courses, Courses Ammount ), save, delete course. + */ + @Service public class CourseService { @Autowired diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/GroupService.java b/buisnesslogic/src/main/java/com/plannaplan/services/GroupService.java index b77dacb..2eae2fb 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/GroupService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/GroupService.java @@ -9,6 +9,10 @@ import com.plannaplan.repositories.GroupRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of GroupService which can find(optional), get(By Course, Groups Ammount, Group By Id, find Not Existing Group), save, delete group. + */ + @Service public class GroupService { @Autowired diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/LecturerService.java b/buisnesslogic/src/main/java/com/plannaplan/services/LecturerService.java index 9a2ee31..75c8ad5 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/LecturerService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/LecturerService.java @@ -8,6 +8,9 @@ import com.plannaplan.repositories.LecturerRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of LecturerService which can get(Lecturer, Lecturers Ammount), save, delete lecturers. + */ @Service public class LecturerService { @Autowired diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/UserService.java b/buisnesslogic/src/main/java/com/plannaplan/services/UserService.java index 73a0644..f91121f 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/UserService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/UserService.java @@ -12,6 +12,9 @@ import com.plannaplan.types.UserRoles; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; +/** + * Service of UserService which can get(By Email), login, save user. + */ @Service public class UserService { @Autowired