Push current changes (working on documentation and tests)

1 files changed, 16 insertions, 9 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
index 860a2a8..6052e4f 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
@@ -5,17 +5,17 @@ import java.util.Arrays;
 
 import com.ufund.api.ufundapi.model.Need;
 import com.ufund.api.ufundapi.persistence.CupboardDAO;
+import org.springframework.stereotype.Component;
 
+@Component
 public class CupboardService {
 
     private final CupboardDAO cupboardDAO;
 
     public class DuplicateKeyException extends Exception {
-
         public DuplicateKeyException(String message) {
             super(message);
         }
-
     }
 
     public CupboardService(CupboardDAO cupboardDAO) {
@@ -57,27 +57,34 @@ public class CupboardService {
     }
 
     /**
-     * @param id
-     * @return
-     * @throws IOException
+     * Gets a need with the specified ID
+     *
+     * @param id the ID of the need
+     * @return The resulting Need or null if the need was not found
      */
     public Need getNeed(int id) throws IOException {
         return cupboardDAO.getNeed(id);
     }
 
     /**
-     * 
+     * Modify a need
+     *
      * @param need
      * @return
-     * @throws IOException
+     * @throws IOException Thrown if there was an issue saving the changes
      */
     public Need updateNeed(Need need) throws IOException {
         return cupboardDAO.updateNeed(need);
     }
 
+    /**
+     * Delete a need from the cupboard
+     *
+     * @param id the ID of the need
+     * @return True if the need was deleted
+     * @throws IOException Thrown on any problem removing the need
+     */
     public boolean deleteNeed(int id) throws IOException {
         return cupboardDAO.deleteNeed(id);
     }
-
-    
 }