Mercurial > lada > lada-server
diff src/main/java/de/intevation/lada/rest/stamm/MessgroesseService.java @ 630:44d7ff0461f2
Code documentation.
author | Raimund Renkert <raimund.renkert@intevation.de> |
---|---|
date | Thu, 23 Apr 2015 10:40:36 +0200 |
parents | b3eee6414310 |
children | c0da629ba69d |
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/rest/stamm/MessgroesseService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/MessgroesseService.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,53 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for Messgroesse 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":[number], + * "beschreibung": [string], + * "defaultFarbe": [string], + * "eudfNuklidId": [number], + * "idfNuklidKey": [string], + * "istLeitnuklid": [boolean], + * "kennungBvl": [string], + * "messgroesse": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("messgroesse") @RequestScoped public class MessgroesseService { - /* The data repository granting read/write access.*/ + /** + * The data repository granting read access. + */ @Inject @RepositoryConfig(type=RepositoryType.RO) private Repository defaultRepo; /** - * Get all objects. + * Get all Messgroesse objects. + * <p> + * Example: http://example.com/messgroesse * - * @return Response object containing all messung objects. + * @return Response object containing all Messgroesse objects. */ @GET @Path("/") @@ -49,9 +83,13 @@ } /** - * Get an object by id. + * Get a single Messgroesse object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/messgroesse/{id} * - * @return Response object containing a single object. + * @return Response object containing a single Messgroesse. */ @GET @Path("/{id}")