Mercurial > lada > lada-server
changeset 630:44d7ff0461f2
Code documentation.
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/rest/stamm/DatenbasisService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/DatenbasisService.java Thu Apr 23 10:40:36 2015 +0200 @@ -28,8 +28,6 @@ * REST service for Datenbasis objects. * <p> * The services produce data in the application/json media type. - * All HTTP methods use the authorization module to determine if the user is - * allowed to perform the requested action. * A typical response holds information about the action performed and the data. * <pre> * <code> @@ -80,7 +78,7 @@ } /** - * Get an single Datenbasis object by id. + * Get a single Datenbasis object by id. * <p> * The id is appended to the URL as a path parameter. * <p>
--- a/src/main/java/de/intevation/lada/rest/stamm/KoordinatenartService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/KoordinatenartService.java Thu Apr 23 10:40:36 2015 +0200 @@ -24,19 +24,48 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for KoordinatenArt 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], + * "idfGeoKey": [string], + * "koordinatenArt": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("koordinatenart") @RequestScoped public class KoordinatenartService { - /* 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 KoordinatenArt objects. + * <p> + * Example: http://example.com/koordinatenart * - * @return Response object containing all objects. + * @return Response object containing all KoordinatenArt objects. */ @GET @Path("/") @@ -49,9 +78,13 @@ } /** - * Get an object by id. + * Get a single KoordinatenArt object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/koordinatenart/{id} * - * @return Response object containing a single object. + * @return Response object containing a single KoordinatenArt. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/LocationService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/LocationService.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; @@ -29,19 +29,64 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for SOrt 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], + * "bezeichnung": [string], + * "hoeheLand": [number], + * "koordXExtern": [string], + * "koordYExtern": [string], + * "latitude": [number], + * "letzteAenderung": [timestamp], + * "longitude": [number], + * "nutsCode": [string], + * "unscharf": [string], + * "koordinatenartId": [number], + * "netzbetreiberId": [number], + * "staatId": [number], + * "verwaltungseinheitId": [string], + * "otyp": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("location") @RequestScoped public class LocationService { - /* The data repository granting read/write access.*/ + /** + * The data repository granting read/write access. + */ @Inject @RepositoryConfig(type=RepositoryType.RW) private Repository defaultRepo; /** - * Get all objects. + * Get all SOrt objects. + * <p> + * The requested objects can be filtered using a URL parameter named + * ortId. + * <p> + * Example: http://example.com/location?ortId=[ID] * - * @return Response object containing all objects. + * @return Response object containing all (filtered) SOrt objects. */ @GET @Path("/") @@ -64,9 +109,13 @@ } /** - * Get an object by id. + * Get a single SOrt object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/location/{id} * - * @return Response object containing a single object. + * @return Response object containing a single SOrt. */ @GET @Path("/{id}") @@ -81,6 +130,32 @@ "stamm"); } + /** + * Create a SOrt object. + * <p> + * The new object is embedded in the post data as JSON formatted string. + * <p> + * <pre> + * <code> + * { + * "bezeichnung": [string], + * "beschreibung": [string], + * "unscharf": [string], + * "nutsCode": [string], + * "koordXExtern": [string], + * "koordYExtern": [string], + * "hoeheLand": [string], + * "longitude": [number], + * "latitude": [number], + * "staatId": [number], + * "verwaltungseinheitId": [string], + * "otyp": [string], + * "letzteAenderung": [date] + * } + * </code> + * </pre> + * @return A response object containing the created SOrt. + */ @POST @Path("/") @Produces(MediaType.APPLICATION_JSON) @@ -93,9 +168,31 @@ } /** - * Update an existing object. + * Update an existing SOrt object. + * <p> + * The object to update should come as JSON formatted string. + * <pre> + * <code> + * { + * "id": [number], + * "bezeichnung": [string], + * "beschreibung": [string], + * "unscharf": [string], + * "nutsCode": [string], + * "koordXExtern": [string], + * "koordYExtern": [string], + * "hoeheLand": [number], + * "longitude": [number], + * "latitude": [number], + * "staatId": [number], + * "verwaltungseinheitId": [string], + * "otyp": [string], + * "letzteAenderung": [date] + * } + * </code> + * </pre> * - * @return Response object containing the updated object. + * @return Response object containing the updated SOrt object. */ @PUT @Path("/") @@ -109,7 +206,11 @@ } /** - * Delete an existing object by id. + * Delete an existing SOrt object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/location/{id} * * @return Response object. */
--- a/src/main/java/de/intevation/lada/rest/stamm/MesseinheitService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/MesseinheitService.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,50 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for MessEinheit 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], + * "einheit": [string], + * "eudfMesseinheitId": [string], + * "umrechnungsFaktorEudf": [number] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("messeinheit") @RequestScoped public class MesseinheitService { - /* 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 MessEinheit objects. + * <p> + * Example: http://example.com/messeinheit * - * @return Response object containing all messung objects. + * @return Response object containing all MessEinheit objects. */ @GET @Path("/") @@ -49,9 +80,13 @@ } /** - * Get an object by id. + * Get a single MessEinheit object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/messeinheit/{id} * - * @return Response object containing a single object. + * @return Response object containing a single MessEinheit. */ @GET @Path("/{id}")
--- 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}")
--- 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}")
--- a/src/main/java/de/intevation/lada/rest/stamm/MessstelleService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/MessstelleService.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; @@ -32,24 +32,58 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for MessStelle 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], + * "amtskennung": [string], + * "beschreibung": [string], + * "messStelle": [string], + * "mstTyp": [string], + * "netzbetreiberId": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("messstelle") @RequestScoped public class MessstelleService { - /* The data repository granting read/write access.*/ + /** + * The data repository granting read access. + */ @Inject @RepositoryConfig(type=RepositoryType.RO) private Repository defaultRepo; - /* The authorization module.*/ + /** + * The authorization module. + */ @Inject @AuthorizationConfig(type=AuthorizationType.OPEN_ID) private Authorization authorization; /** - * Get all objects. + * Get all MessStelle objects. + * <p> + * Example: http://example.com/messstelle * - * @return Response object containing all objects. + * @return Response object containing all MessStelle objects. */ @GET @Path("/") @@ -68,9 +102,13 @@ } /** - * Get an object by id. + * Get a single MessStelle object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/messstelle/{id} * - * @return Response object containing a single object. + * @return Response object containing a single MessStelle. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/NetzbetreiberService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/NetzbetreiberService.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; @@ -32,24 +32,59 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for NetzBetreiber 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], + * "aktiv": [boolean], + * "idfNetzbetreiber": [string], + * "isBmn": [boolean], + * "mailverteiler": [string], + * "netzbetreiber": [string], + * "zustMstId": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("netzbetreiber") @RequestScoped public class NetzbetreiberService { - /* The data repository granting read/write access.*/ + /** + * The data repository granting read access. + */ @Inject @RepositoryConfig(type=RepositoryType.RO) private Repository defaultRepo; - /* The authorization module.*/ + /** + * The authorization module. + */ @Inject @AuthorizationConfig(type=AuthorizationType.OPEN_ID) private Authorization authorization; /** - * Get all objects. + * Get all NetzBetreiber objects. + * <p> + * Example: http://example.com/netzbetreiber * - * @return Response object containing all objects. + * @return Response object containing all NetzBetreiber objects. */ @GET @Path("/") @@ -68,9 +103,13 @@ } /** - * Get an object by id. + * Get a single NetzBetreiber object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/netzbetreiber/{id} * - * @return Response object containing a single object. + * @return Response object containing a single NetzBetreiber. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/PflichtmessgroesseService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/PflichtmessgroesseService.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,50 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for PflichtMessgroesse 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], + * "messgroesseId": [number], + * "datenbasisId": [number], + * "mmtId": [string], + * "umweltId": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("pflichtmessgroesse") @RequestScoped public class PflichtmessgroesseService { - /* 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 PflichtMessgroesse objects. + * <p> + * Example: http://example.com/pflichtmessgroesse * - * @return Response object containing all objects. + * @return Response object containing all PflichtMessgroesse objects. */ @GET @Path("/") @@ -49,9 +80,13 @@ } /** - * Get an object by id. + * Get a single PflichtMessgroesse object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/pflichtmessgroesse/{id} * - * @return Response object containing a single object. + * @return Response object containing a single PflichtMessgroesse. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/ProbenartService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/ProbenartService.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,49 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for Probenart 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], + * "probenart": [string], + * "probenartEudfId": [string] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("probenart") @RequestScoped public class ProbenartService { - /* 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 Probenart objects. + * <p> + * Example: http://example.com/probenart * - * @return Response object containing all objects. + * @return Response object containing all Probenart objects. */ @GET @Path("/") @@ -49,9 +79,13 @@ } /** - * Get an object by id. + * Get a single Probenart object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/probenart/{id} * - * @return Response object containing a single object. + * @return Response object containing a single Probenart. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/ProbenzusatzService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/ProbenzusatzService.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,50 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for ProbenZusatz 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], + * "eudfKeyword": [string], + * "zusatzwert": [string], + * "mehId": [number] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("probenzusatz") @RequestScoped public class ProbenzusatzService { - /* 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 ProbenZusatz objects. + * <p> + * Example: http://example.com/probenzusatz * - * @return Response object containing all objects. + * @return Response object containing all ProbenZusatz objects. */ @GET @Path("/") @@ -49,9 +80,13 @@ } /** - * Get an object by id. + * Get a single ProbenZusatz object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/probenzusatz/{id} * - * @return Response object containing a single object. + * @return Response object containing a single ProbenZusatz. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/StaatService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/StaatService.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,54 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for Staat 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], + * "eu": [string], + * "hklId": [number], + * "koordXExtern": [string], + * "koordYExtern": [string], + * "staat": [string], + * "staatIso": [string], + * "staatKurz": [string], + * "koordinatenartId": [number] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("staat") @RequestScoped public class StaatService { - /* 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 Staat objects. + * <p> + * Example: http://example.com/staat * - * @return Response object containing all objects. + * @return Response object containing all Staat objects. */ @GET @Path("/") @@ -49,9 +84,13 @@ } /** - * Get an object by id. + * Get a single Staat object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/staat/{id} * - * @return Response object containing a single object. + * @return Response object containing a single Staat. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/UmweltService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/UmweltService.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,49 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for Umwelt 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], + * "umweltBereich": [string], + * "mehId": [number] + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("umwelt") @RequestScoped public class UmweltService { - /* 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 Umwelt objects. + * <p> + * Example: http://example.com/umwelt * - * @return Response object containing all objects. + * @return Response object containing all Umwelt objects. */ @GET @Path("/") @@ -49,9 +79,13 @@ } /** - * Get an object by id. + * Get a single Umwelt object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/umwelt/{id} * - * @return Response object containing a single object. + * @return Response object containing a single Umwelt. */ @GET @Path("/{id}")
--- a/src/main/java/de/intevation/lada/rest/stamm/VerwaltungseinheitService.java Thu Apr 23 08:45:25 2015 +0200 +++ b/src/main/java/de/intevation/lada/rest/stamm/VerwaltungseinheitService.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; @@ -26,19 +26,48 @@ import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.Response; +/** + * REST service for Verwaltungseinheit 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":[{ + * }], + * "errors": [object], + * "warnings": [object], + * "readonly": [boolean], + * "totalCount": [number] + * } + * </code> + * </pre> + * + * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> + */ @Path("verwaltungseinheit") @RequestScoped public class VerwaltungseinheitService { - /* 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 Verwaltungseinheit objects. + * <p> + * The result list can be filtered using the URL parameter 'query'. A filter + * is defined as the first letters of the 'bezeichnung' + * <p> + * Example: http://example.com/verwaltungseinheit?query=[string] * - * @return Response object containing all objects. + * @return Response object containing all Verwaltungseinheit objects. */ @GET @Path("/") @@ -60,9 +89,13 @@ } /** - * Get an object by id. + * Get a single Verwaltungseinheit object by id. + * <p> + * The id is appended to the URL as a path parameter. + * <p> + * Example: http://example.com/verwaltungseinheit/{id} * - * @return Response object containing a single object. + * @return Response object containing a single Verwaltungseinheit. */ @GET @Path("/{id}")