From a731dae5cb3f0982cc3e6d64cc46b118e90bff89 Mon Sep 17 00:00:00 2001 From: mskomarov Date: Mon, 17 Jun 2019 12:15:18 +1000 Subject: [PATCH 1/3] Remove unnesessary comment --- src/main/java/io/khasang/pm/entity/ChildDocument.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/io/khasang/pm/entity/ChildDocument.java b/src/main/java/io/khasang/pm/entity/ChildDocument.java index 34954b2..9b47682 100644 --- a/src/main/java/io/khasang/pm/entity/ChildDocument.java +++ b/src/main/java/io/khasang/pm/entity/ChildDocument.java @@ -3,7 +3,6 @@ import javax.persistence.*; @Entity -//@Table(name = "documents") public class ChildDocument { @Id @GeneratedValue(strategy = GenerationType.AUTO) From 2c0533ad496a4cf3b7a3965ef41d708dc638a110 Mon Sep 17 00:00:00 2001 From: mskomarov Date: Mon, 17 Jun 2019 12:20:09 +1000 Subject: [PATCH 2/3] Adding javadoc to methods update(), delete() in BasicDao interface. --- src/main/java/io/khasang/pm/dao/BasicDao.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/main/java/io/khasang/pm/dao/BasicDao.java b/src/main/java/io/khasang/pm/dao/BasicDao.java index 2e1675d..d254e88 100644 --- a/src/main/java/io/khasang/pm/dao/BasicDao.java +++ b/src/main/java/io/khasang/pm/dao/BasicDao.java @@ -11,8 +11,20 @@ public interface BasicDao { */ T add(T entity); + /** + * updating entity in db + * + * @param entity - entity for update in db + * @return udated entity + */ T update(T entity); + /** + * deleting entity in db + * + * @param entity - entity for deleting from db + * @return deleted entity + */ T delete(T entity); /** From ead6f1a23e3f887cd74f89f036ed64d7bccbd70d Mon Sep 17 00:00:00 2001 From: mskomarov Date: Mon, 17 Jun 2019 12:32:42 +1000 Subject: [PATCH 3/3] Adding javadoc to methods in ChildDocumentService interface. --- .../pm/service/ChildDocumentService.java | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/src/main/java/io/khasang/pm/service/ChildDocumentService.java b/src/main/java/io/khasang/pm/service/ChildDocumentService.java index 3acc4f3..2f686e8 100644 --- a/src/main/java/io/khasang/pm/service/ChildDocumentService.java +++ b/src/main/java/io/khasang/pm/service/ChildDocumentService.java @@ -5,13 +5,42 @@ import java.util.List; public interface ChildDocumentService { + /** + * required for adding childDocument to db + * + * @param childDocument - childDocument for adding + * @return added childDocument + */ ChildDocument add(ChildDocument childDocument); + /** + * required for updating childDocument in db + * + * @param childDocument - childDocument for update + * @return updated childDocument + */ ChildDocument update(ChildDocument childDocument); + /** + * required for deleting childDocument from db + * + * @param id - childDocument's id for deleting + * @return deleted childDocument + */ ChildDocument delete(long id); + /** + * getting specify childDocument by ID from db + * + * @param id - childDocument's id for receiving + * @return childDocument by id + */ ChildDocument getById(long id); + /** + * getting all childDocuments + * + * @return all childDocument from db + */ List getAllChildDocuments(); }