java doc for flashcard request model

Author: jempio

src/main/java/data_access_use_case/entity_request_models/CommonUserDsRequestModel.java

@@ -1,7 +1,11 @@
 package data_access_use_case.entity_request_models;
 
 import java.util.List;
-
+/**
+ * Common User Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 public class CommonUserDsRequestModel {
     private final String username;
     private final String password;

src/main/java/data_access_use_case/entity_request_models/FlashcardDsRequestModel.java

@@ -1,7 +1,11 @@
 package data_access_use_case.entity_request_models;
-// use case layer
 
 import java.time.LocalDateTime;
+/**
+ * Flashcard Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public class FlashcardDsRequestModel {
     private String term;
@@ -10,6 +14,14 @@ public class FlashcardDsRequestModel {
     private int flashcardId;
     private final int belongsToId;
 
+    /**
+     * Creates a flashcard response model based on the following parameters.
+     * @param term the flashcard term
+     * @param definition the flashcard definition for the term
+     * @param creationDate the time the flashcard is created (time formatted in LocalDateTime)
+     * @param flashcardId the flashcard id
+     * @param belongsToId the id of the flashcard set that the flashcard is in.
+     */
     public FlashcardDsRequestModel(String term, String definition, LocalDateTime creationDate,
                                    int flashcardId, int belongsToId){
         this.term = term;
@@ -18,33 +30,54 @@ public FlashcardDsRequestModel(String term, String definition, LocalDateTime cre
         this.flashcardId = flashcardId;
         this.belongsToId = belongsToId;
     }
+    /**
+     * Gets the flashcard term.
+     * @return the flashcard term
+     */
     public String getTerm() {
         return term;
     }
-
+    /**
+     * Gets the flashcard definition.
+     * @return the flashcard definition.
+     */
     public String getDefinition() {
         return definition;
     }
-
+    /**
+     * Gets the flashcard creation date.
+     * @return the flashcard creation date in LocalDateTime formatting.
+     */
     public LocalDateTime getCreationDate() {
         return creationDate;
     }
-
+    /**
+     * Gets the flashcard id.
+     * @return the flashcard id.
+     */
     public int getFlashcardId(){
         return flashcardId;
     }
-
+    /**
+     * Gets the id of the flashcard set that the flashcard belongs to.
+     * @return the id of the flashcard set that the flashcard belongs to.
+     */
     public int getBelongsToId(){
         return belongsToId;
     }
-    public void setTerm(String term) {
-        this.term = term;
-    }
-
+    /**
+     * Sets the term.
+     */
+    public void setTerm(String term) {this.term = term;}
+    /**
+     * Sets the definition.
+     */
     public void setDefinition(String definition) {
         this.definition = definition;
     }
-
+    /**
+     * Sets the flashcard id.
+     */
     public void setFlashcardId(int flashcardId) {
         this.flashcardId = flashcardId;
     }

src/main/java/data_access_use_case/entity_request_models/FlashcardSetDsRequestModel.java

@@ -1,6 +1,11 @@
 package data_access_use_case.entity_request_models;
 
 import java.util.List;
+/**
+ * Flashcard Set Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public class FlashcardSetDsRequestModel {
     private String title;
@@ -11,6 +16,14 @@ public class FlashcardSetDsRequestModel {
     private final String ownerUsername;
     private int flashcardSetId;
 
+    /**
+     * Creates a flashcard response model based on the following parameters.
+     * @param title the flashcard set title
+     * @param description the flashcard set description.
+     * @param isPrivate true if the flashcard set is private.
+     * @param flashcardSetId the flashcard set id
+     * @param ownerUsername the id of the user that created the flashcard set.
+     */
     public FlashcardSetDsRequestModel(String title, String description, boolean isPrivate,
                         int flashcardSetId, String ownerUsername,
                         List<Integer> flashcardIds){