diff src/main/java/de/intevation/lada/rest/stamm/MessmethodeService.java @ 630:44d7ff0461f2

Code documentation.
author Raimund Renkert <raimund.renkert@intevation.de>
date Thu, 23 Apr 2015 10:40:36 +0200
parents b3eee6414310
children 5bdd1631a451
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/rest/stamm/MessmethodeService.java	Thu Apr 23 08:45:25 2015 +0200
+++ b/src/main/java/de/intevation/lada/rest/stamm/MessmethodeService.java	Thu Apr 23 10:40:36 2015 +0200
@@ -1,9 +1,9 @@
 /* Copyright (C) 2013 by Bundesamt fuer Strahlenschutz
  * Software engineering by Intevation GmbH
  *
- * This file is Free Software under the GNU GPL (v>=3) 
- * and comes with ABSOLUTELY NO WARRANTY! Check out 
- * the documentation coming with IMIS-Labordaten-Application for details. 
+ * This file is Free Software under the GNU GPL (v>=3)
+ * and comes with ABSOLUTELY NO WARRANTY! Check out
+ * the documentation coming with IMIS-Labordaten-Application for details.
  */
 package de.intevation.lada.rest.stamm;
 
@@ -24,19 +24,48 @@
 import de.intevation.lada.util.data.RepositoryType;
 import de.intevation.lada.util.rest.Response;
 
+/**
+ * REST service for MessMethode objects.
+ * <p>
+ * The services produce data in the application/json media type.
+ * A typical response holds information about the action performed and the data.
+ * <pre>
+ * <code>
+ * {
+ *  "success": [boolean];
+ *  "message": [string],
+ *  "data":[{
+ *      "id": [string],
+ *      "beschreibung": [string],
+ *      "messmethode": [string]
+ *  }],
+ *  "errors": [object],
+ *  "warnings": [object],
+ *  "readonly": [boolean],
+ *  "totalCount": [number]
+ * }
+ * </code>
+ * </pre>
+ *
+ * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
+ */
 @Path("messmethode")
 @RequestScoped
 public class MessmethodeService {
 
-    /* The data repository granting read/write access.*/
+    /**
+     * The data repository granting read/write access.
+     */
     @Inject
     @RepositoryConfig(type=RepositoryType.RO)
     private Repository defaultRepo;
 
     /**
-     * Get all objects.
+     * Get all MessMethode objects.
+     * <p>
+     * Example: http://example.com/messmethode
      *
-     * @return Response object containing all messung objects.
+     * @return Response object containing all MessMethode objects.
      */
     @GET
     @Path("/")
@@ -49,9 +78,13 @@
     }
 
     /**
-     * Get an object by id.
+     * Get a single MessMethode object by id.
+     * <p>
+     * The id is appended to the URL as a path parameter.
+     * <p>
+     * Example: http://example.com/messmethode/{id}
      *
-     * @return Response object containing a single object.
+     * @return Response object containing a single MessMethode.
      */
     @GET
     @Path("/{id}")
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)