DataHandler Error fixed
[staff/due1/sed-hs15-srs-purple.git] / src / main / java / ch / bfh / ti / srs / datahandler / DataHandler.java
index 5172caa..850f39c 100644 (file)
@@ -36,12 +36,21 @@ public interface DataHandler {
         * @param user
         *            User object
         * @return returns a boolean whether the user was made or not
-        * @throws Exception if some property of the specified element
-     *         prevents it from being added the Datacontext
+        * @throws Exception
+        *             if some property of the specified element prevents it from
+        *             being added the Datacontext
         */
        public boolean addUser(User user) throws Exception;
 
        /**
+        * Edit a User with the same Name.
+        * @param user
+        *            the new User 
+        * @return a boolean whether the user was edited or not
+        */
+       public boolean editUser(User user);
+       
+       /**
         * Finds the resourceName in the Datacontext and returns the Resource object
         * or null if not found
         * @param resourceName
@@ -56,8 +65,9 @@ public interface DataHandler {
         * @param resource
         *            Resource object
         * @return returns a boolean whether the resource was made or not
-        * @throws Exception if some property of the specified element
-     *         prevents it from being added the Datacontext
+        * @throws Exception
+        *             if some property of the specified element prevents it from
+        *             being added the Datacontext
         */
        public boolean addResource(Resource resource) throws Exception;
 
@@ -99,8 +109,7 @@ public interface DataHandler {
 
        /**
         * Finds all reservations
-        * @return <code>List</code> with the all reservation
-        *         objects
+        * @return <code>List</code> with the all reservation objects
         */
        public List<Reservation> findAllReservations();
 
@@ -108,32 +117,67 @@ public interface DataHandler {
         * Adds a reservation to the Datacontext from a given Reservation object
         * @param reservation
         *            Reservation object
-        *            
         * @return a boolean whether the reservation was made or not
-        * @throws Exception if some property of the specified element
-     *         prevents it from being added the Datacontext
+        * @throws Exception
+        *             if some property of the specified element prevents it from
+        *             being added the Datacontext
         */
        public boolean addReservation(Reservation reservation) throws Exception;
-       
+
        /**
         * Saves the current changes on the local data to the datastorage
         */
        public void saveChanges();
-       
+
        /**
         * Synchronizes the local data with the datastorage
-        * 
         * @param discardChanges
-        *                      <code>true</code> do not try to save the changes
-        *                      <code>false</code> try to save the changes
-        * @throws Exception no implementation for <code>true</code> in this DataHandler possible
+        *            <code>true</code> do not try to save the changes
+        *            <code>false</code> try to save the changes
+        * @throws Exception
+        *             no implementation for <code>true</code> in this DataHandler
+        *             possible
         */
        public void refresh(boolean discardChanges) throws Exception;
 
-
+       /**
+        * Edit a Reservation with the same ID.
+        * @param reservation
+        *            the new Reservation 
+        * @return a boolean whether the reservation was edited or not
+        */
        public boolean editReservation(Reservation reservation);
 
+       /**
+        * deletes a Reservation from the datastorage
+        * @param reservation
+        *            the Reservation to remove
+        * @return a boolean whether the reservation was deleted or not
+        */
        public boolean deleteReservation(Reservation reservation);
 
+       /**
+        * Edit a Resource with the same ID.
+        * @param resource
+        *            the new Resource 
+        * @return a boolean whether the resource was edited or not
+        */
+       public boolean editResource(Resource resource);
+
+       /**
+        * deletes a Resource from the datastorage
+        * @param resource
+        *            the Resource to remove
+        * @return a boolean whether the resource was deleted or not
+        */
+       public boolean deleteResource(Resource resource);
+
+       /**
+        * get all the Resources from the datastorage
+        * 
+        * @return a set of Resources
+        */
        public Set<Resource> getAllResources();
 }
+
+