Author: reto
Date: Mon Feb 15 11:01:04 2010
New Revision: 910201
URL: http://svn.apache.org/viewvc?rev=910201&view=rev
Log:
CLEREZZA-107: made comments more explicit
Modified:
incubator/clerezza/issues/CLEREZZA-107/org.apache.clerezza.platform.usermanager/src/main/java/org/apache/clerezza/platform/usermanager/UserManager.java
Modified:
incubator/clerezza/issues/CLEREZZA-107/org.apache.clerezza.platform.usermanager/src/main/java/org/apache/clerezza/platform/usermanager/UserManager.java
URL:
http://svn.apache.org/viewvc/incubator/clerezza/issues/CLEREZZA-107/org.apache.clerezza.platform.usermanager/src/main/java/org/apache/clerezza/platform/usermanager/UserManager.java?rev=910201&r1=910200&r2=910201&view=diff
==============================================================================
---
incubator/clerezza/issues/CLEREZZA-107/org.apache.clerezza.platform.usermanager/src/main/java/org/apache/clerezza/platform/usermanager/UserManager.java
(original)
+++
incubator/clerezza/issues/CLEREZZA-107/org.apache.clerezza.platform.usermanager/src/main/java/org/apache/clerezza/platform/usermanager/UserManager.java
Mon Feb 15 11:01:04 2010
@@ -149,7 +149,7 @@
public boolean nameExists(String name);
/**
- * Checks if the email exists
+ * Checks if thereis already an agent with that email address.
*
* @param email
* @return true if exists otherwise false
@@ -169,7 +169,7 @@
/**
*
* @param name specifies the username of the user
- * @return NonLiteral which is either a BNode or a UriRef
+ * @return NonLiteral representing the user in the system Graph
*/
@Deprecated
public NonLiteral getUserByName(String name);
@@ -177,13 +177,13 @@
/**
* Returns the user with the specified name in an (editable) MGraph
* (i.e. a SimpleGraph but this is implementation specific) with the
context
- * of the user node, editing the graphnode('s Mgaph) doesn't cause any
+ * of the user node, editing the graphnode('s Mgraph) doesn't cause any
* changes elsewhere. Returns null if the user does not exist.
* The caller of this method needs the permission to read the system
graph,
* otherwise a AccessControlException will be thrown.
*
- * @param name The name of the user
- * @return
+ * @param name The username of the user
+ * @return GraphNode representing the suer with some context in a
dedicated MGraph
*/
public GraphNode getUserGraphNode(String name);
@@ -192,8 +192,8 @@
* specified name in the system graph. Returns null if the user does not
* exist.
*
- * @param name The name of the user
- * @return
+ * @param name The username of the user
+ * @return GraphNode represing the user in the system graph
*/
public GraphNode getUserInSystemGraph(String name);
@@ -204,15 +204,15 @@
* PLATFORM.userName property copied from the system graph. Returns
null if
* the user does not exist.
*
- * @param name The name of the user
- * @return
+ * @param name The username of the user
+ * @return GraphNode representing the user in the content graph
*/
public GraphNode getUserInContentGraph(String name);
/**
* Returns all users.
*
- * @return Iterator defining all users.
+ * @return Iterator of users in the system Graph.
*/
public Iterator<NonLiteral> getUsers();
