java doc for IFlashcardSetDataAccess

Author: jempio

src/main/java/data_access/IFlashcardSetDataAccess.java

@@ -2,21 +2,45 @@
 
 import data_access.entity_request_models.FlashcardSetDsRequestModel;
 
-// use case layer
+/**
+ * User Data Access Interface.
+ * Application Business Rules
+ * @author Justin Li
+ */
+
 public interface IFlashcardSetDataAccess {
 
+    /**
+     * @param flashcardSetId the id of the flashcard set.
+     * @return the flashcardSet object by the id given.
+     */
     FlashcardSetDsRequestModel getFlashcardSet(int flashcardSetId);
-
+    /**
+     * @param flashcardSetId the id of the flashcard set.
+     * @return the title and description of the flashcard set.
+     */
     String[] getTitleAndDescription(int flashcardSetId);
-
+    /**
+     * @param flashcardSet the flashcard set object.
+     */
     void editTitleAndDescription(FlashcardSetDsRequestModel flashcardSet);
-
+    /**
+     * @param flashcardSetId the id of the flashcard set.
+     * @param flashcardId the id of the flashcard that will be added.
+     */
     void saveFlashcardID(int flashcardSetId, int flashcardId);
-
+    /**
+     * @param flashcardSetId the id of the flashcard set.
+     * @param flashcardId the id of the flashcard that will be removed.
+     */
     void removeFlashcardId(int flashcardSetId, int flashcardId);
-
-    void deleteFlashcardSet(int flashcardSetID);
-
+    /**
+     * @param flashcardSetId the id of the flashcard set that will be deleted.
+     */
+    void deleteFlashcardSet(int flashcardSetId);
+    /**
+     * @param flashcardSet the flashcard set object.
+     */
     int saveFlashcardSet(FlashcardSetDsRequestModel flashcardSet);
 
 

src/main/java/data_access/IUserDataAccess.java

@@ -28,14 +28,14 @@ public interface IUserDataAccess {
     Collection<CommonUserDsRequestModel> getAllUsers();
     /**
      * @param username the user's username
-     * @param flashcardSetID the id of the flashcard set that the user would like to create.
+     * @param flashcardSetId the id of the flashcard set that the user would like to create.
      */
-    void saveFlashcardSetID(String username, int flashcardSetID);
+    void saveFlashcardSetID(String username, int flashcardSetId);
     /**
      * @param username the user's username
-     * @param flashcardSetID the id of the flashcard set that the user would like to delete.
+     * @param flashcardSetId the id of the flashcard set that the user would like to delete.
      */
-    void deleteFlashcardSetID(String username, int flashcardSetID);
+    void deleteFlashcardSetID(String username, int flashcardSetId);
     /**
      * @param user the User object.
      */