Buisness logic docs packages
This commit is contained in:
parent
21983fe4f7
commit
bf7d0c7dbc
6
buisnesslogic/src/main/java/com/plannaplan/api/package-info.java
Executable file
6
buisnesslogic/src/main/java/com/plannaplan/api/package-info.java
Executable file
@ -0,0 +1,6 @@
|
||||
/**
|
||||
* Provides the classes necessary to obtain usos authentication with Oauth1
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.api;
|
7
buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java
Executable file
7
buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java
Executable file
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* Provides the classes necessary to to config and import related operations in
|
||||
* the app
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.configutils;
|
6
buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java
Executable file
6
buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java
Executable file
@ -0,0 +1,6 @@
|
||||
/**
|
||||
* Provides all entieites that are created in database by Hibernate
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.entities;
|
6
buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java
Executable file
6
buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java
Executable file
@ -0,0 +1,6 @@
|
||||
/**
|
||||
* Provides custom for our app exceptions to get more accutrate errors info
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.exceptions;
|
@ -79,7 +79,8 @@ public class MatchData {
|
||||
* Exchanges 12:00 and 12:00
|
||||
*
|
||||
* @param m1 MatchData instance to compare to
|
||||
* @return int <0 if m1 is "less than", 0 if it's equal and >0 otherwise
|
||||
* @return int less than 0 if m1 is "less than", 0 if it's equal and more than 0
|
||||
* otherwise
|
||||
*/
|
||||
public int compare(MatchData m1) {
|
||||
return Long.compare(m1.getExchangesMsValue(), this.getExchangesMsValue());
|
||||
|
@ -39,7 +39,7 @@ public class UserApiResponse {
|
||||
* setter for surname. Reson to have setters for this class is for case if there
|
||||
* would be name and no surname or otherwise
|
||||
*
|
||||
* @param surname name to set that was obtained by api request
|
||||
* @param name name to set that was obtained by api request
|
||||
*/
|
||||
public void setName(String name) {
|
||||
this.name = name;
|
||||
|
6
buisnesslogic/src/main/java/com/plannaplan/models/package-info.java
Executable file
6
buisnesslogic/src/main/java/com/plannaplan/models/package-info.java
Executable file
@ -0,0 +1,6 @@
|
||||
/**
|
||||
* Provides readonly (mostly) classes to keep data for diffrent pourposes
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.models;
|
@ -4,5 +4,8 @@ import com.plannaplan.entities.AppConfig;
|
||||
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
|
||||
/**
|
||||
* Repository for app config
|
||||
*/
|
||||
public interface AppConfigRepository extends JpaRepository<AppConfig, Long> {
|
||||
}
|
||||
|
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* Provides jpa repositories interfaces to comunicate with database. These are
|
||||
* used exclusively in services
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.repositories;
|
@ -22,7 +22,7 @@ public class CourseService {
|
||||
/**
|
||||
* getCourseByName
|
||||
*
|
||||
* @param name
|
||||
* @param name name of course to be found
|
||||
* @return Course By Name
|
||||
*/
|
||||
public Optional<Course> getCourseByName(String name) {
|
||||
|
7
buisnesslogic/src/main/java/com/plannaplan/services/package-info.java
Executable file
7
buisnesslogic/src/main/java/com/plannaplan/services/package-info.java
Executable file
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* Provides service classes to make operations with entities or comunicate with
|
||||
* external systems.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.services;
|
6
buisnesslogic/src/main/java/com/plannaplan/types/package-info.java
Executable file
6
buisnesslogic/src/main/java/com/plannaplan/types/package-info.java
Executable file
@ -0,0 +1,6 @@
|
||||
/**
|
||||
* Provides enums for different goals.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
package com.plannaplan.types;
|
Loading…
Reference in New Issue
Block a user