java doc for IFlashcardDataAccess

Author: jempio

src/main/java/data_access/IFlashcardDataAccess.java

@@ -2,16 +2,29 @@
 
 import data_access.entity_request_models.FlashcardDsRequestModel;
 
-// use case layer
-
-public interface    IFlashcardDataAccess {
-
-    FlashcardDsRequestModel getFlashcard(Integer flashcardID);
-
+/**
+ * User Data Access Interface.
+ * Application Business Rules
+ * @author Justin Li
+ */
+
+public interface IFlashcardDataAccess {
+    /**
+     * @param flashcardId the id of the flashcard.
+     * @return the flashcard object with the given id.
+     */
+    FlashcardDsRequestModel getFlashcard(Integer flashcardId);
+    /**
+     * @param flashcard the flashcard object that will be created.
+     */
     int saveFlashcard(FlashcardDsRequestModel flashcard);
-
+    /**
+     * @param flashcard the flashcard object that will be edited.
+     */
     void editFlashcard(FlashcardDsRequestModel flashcard);
-
-    void deleteFlashcard(Integer flashcardID);
+    /**
+     * @param flashcardId the id of the flashcard that will be deleted.
+     */
+    void deleteFlashcard(Integer flashcardId);
 
 }