diff src/main/java/de/intevation/lada/validation/Validator.java @ 263:2098db2e8fbd M1

Code documentation.
author Raimund Renkert <rrenkert@intevation.de>
date Wed, 17 Jul 2013 09:40:53 +0200
parents 0de24f5e7c01
children 183f8116d9a6
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/validation/Validator.java	Wed Jul 17 09:40:35 2013 +0200
+++ b/src/main/java/de/intevation/lada/validation/Validator.java	Wed Jul 17 09:40:53 2013 +0200
@@ -9,6 +9,16 @@
  */
 public interface Validator
 {
+    /**
+     * Validate a database object.
+     * 
+     * @param object    The object to validate.
+     * @param update    The database operation.
+     *                  TRUE indicates that the object should be updated, FALSE
+     *                  if the object is a new Object.
+     * @return Map containing warnings.
+     * @throws ValidationException
+     */
     public Map<String, Integer> validate(Object object, boolean update)
     throws ValidationException;
 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)