DataHandler updated
[staff/due1/sed-hs15-srs-purple.git] / src / main / java / ch / bfh / ti / srs / datahandler / DataHandler.java
index a0b79ed..4cbf576 100644 (file)
@@ -1,33 +1,71 @@
-/*\r
- * Copyright (c) 2015 Berner Fachhochschule, Switzerland.\r
- *\r
- * Project Smart Reservation System.\r
- *\r
- * Distributable under GPL license. See terms of license at gnu.org.\r
- */\r
-package ch.bfh.ti.srs.datahandler;\r
-\r
-import ch.bfh.ti.srs.dataschema.User;\r
-\r
-/**\r
- * @author Michael Grossen\r
- */\r
-public interface DataHandler {\r
-       \r
-       /**\r
-        * Finds the user by userName param in the Datacontext and returns the User object or null if not found\r
-        * \r
-        * @param userName      userName of the user you are looking for\r
-        * @return                      <code>User</code>user object\r
-        *                                      <code>null</code>if no user found with this userName\r
-        */\r
-       public User findUser(String userName);\r
-       \r
-       /**\r
-        * Adds a user to the Datacontext from a given user object\r
-        * \r
-        * @param user                  User object\r
-        * @throws Exception\r
-        */\r
-       public void addUser(User user) throws Exception;\r
-}\r
+/*
+ * Copyright (c) 2015 Berner Fachhochschule, Switzerland.
+ *
+ * Project Smart Reservation System.
+ *
+ * Distributable under GPL license. See terms of license at gnu.org.
+ */
+package ch.bfh.ti.srs.datahandler;
+
+import ch.bfh.ti.daterange.DateRange;
+import ch.bfh.ti.srs.dataschema.Reservation;
+import ch.bfh.ti.srs.dataschema.Resource;
+import ch.bfh.ti.srs.dataschema.User;
+
+/**
+ * @author Michael Grossen
+ */
+public interface DataHandler {
+       
+       /**
+        * Finds the user by userName param in the Datacontext and returns the User object or null if not found
+        * 
+        * @param userName      userName of the user you are looking for
+        * @return                      <code>User</code>user object
+        *                                      <code>null</code>if no user found with this userName
+        */
+       public User findUser(String userName);
+       
+       /**
+        * Adds a user to the Datacontext from a given User object
+        * 
+        * @param user                  User object
+        * @throws Exception
+        */
+       public void addUser(User user) throws Exception;
+       
+       /**
+        * Finds the resourceName in the Datacontext and returns the Resource object or null if not found
+        * 
+        * @param resourceName  resource name of the recource you are looking for
+        * @return                              <code>Resource</code>resource object
+        *                                              <code>null</code>if no resource found with this recourceName
+        */
+       public Resource findResource(String resourceName);
+       
+       /**
+        * Adds a resource to the Datacontext from a given Recource object
+        * 
+        * @param resource                      Resource object
+        * @throws Exception
+        */
+       public void addResource(Resource resource) throws Exception;
+       
+       /**
+        * Finds the reservation by resource and daterange param in the Datacontext and returns the Reservation object or null if not found
+        * 
+        * @param       resource        resource of the Reservation you are looking for
+        *                      daterange       daterange of the Reservation you are looking for
+        * @return                              <code>Reservation</code>reservation object
+        *                                              <code>null</code>if no reservation found with this resource and this daterange
+        */
+       public Reservation findReservation(Resource resource, DateRange daterange);
+       
+       /**
+        * Adds a reservation to the Datacontext from a given Reservation object
+        * 
+        * @param reservation                   Reservation object
+        * @throws Exception
+        */
+       public void addReservation(Reservation reservation)throws Exception;
+}