# HG changeset patch
# User Bjoern Ricks <bjoern.ricks@intevation.de>
# Date 1342172477 0
# Node ID 193a113888d48cce8cf3a335bc9ef07b166fabd8
# Parent  98514ab2c9ba1828f638fbeb5cb6abbc1671a727
Add javadoc for the user class


flys-client/trunk@4977 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 98514ab2c9ba -r 193a113888d4 flys-client/ChangeLog
--- a/flys-client/ChangeLog	Fri Jul 13 09:27:53 2012 +0000
+++ b/flys-client/ChangeLog	Fri Jul 13 09:41:17 2012 +0000
@@ -1,3 +1,8 @@
+2012-07-13	Björn Ricks	<bjoern.ricks@intevation.de>
+
+	* src/main/java/de/intevation/flys/client/server/auth/User.java:
+	  Add javadoc for the user class.
+
 2012-07-13	Björn Ricks	<bjoern.ricks@intevation.de>
 
 	* src/main/java/de/intevation/flys/client/server/auth/User.java,
diff -r 98514ab2c9ba -r 193a113888d4 flys-client/src/main/java/de/intevation/flys/client/server/auth/User.java
--- a/flys-client/src/main/java/de/intevation/flys/client/server/auth/User.java	Fri Jul 13 09:27:53 2012 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/server/auth/User.java	Fri Jul 13 09:41:17 2012 +0000
@@ -2,14 +2,30 @@
 
 import java.util.List;
 
+/**
+ * User representation after a succesfull login
+ */
 public interface User {
 
+    /**
+     * Returns the username as String
+     */
     public String getName();
 
+    /**
+     * Returns the password of the user as String
+     */
     public String getPassword();
 
+    /**
+     * Returns True if the authentication for the user
+     * has expired.
+     */
     public boolean hasExpired();
 
+    /**
+     * Returns a list of roles corresponsing the the user
+     */
     public List<String> getRoles();
 }
 // vim:set ts=4 sw=4 si et fenc=utf8 tw=80: