You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by co...@apache.org on 2017/04/26 13:27:02 UTC
syncope git commit: Updating the javadoc for AnyService to make it
clearer how the "key" parameter is used
Repository: syncope
Updated Branches:
refs/heads/master cad371cec -> 4b4b13565
Updating the javadoc for AnyService to make it clearer how the "key" parameter is used
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/4b4b1356
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/4b4b1356
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/4b4b1356
Branch: refs/heads/master
Commit: 4b4b135659d597fcafd5d844954dfa92988dede2
Parents: cad371c
Author: Colm O hEigeartaigh <co...@apache.org>
Authored: Wed Apr 26 14:26:28 2017 +0100
Committer: Colm O hEigeartaigh <co...@apache.org>
Committed: Wed Apr 26 14:26:50 2017 +0100
----------------------------------------------------------------------
.../apache/syncope/common/rest/api/service/AnyService.java | 9 +++++++++
1 file changed, 9 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/4b4b1356/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
----------------------------------------------------------------------
diff --git a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
index ac958e1..d288e59 100644
--- a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
+++ b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
@@ -47,6 +47,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch> extends JAXRSS
/**
* Reads the list of attributes owned by the given any object for the given schema type.
*
+ * Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter
+ * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+ *
* @param key any object key
* @param schemaType schema type
* @return list of attributes, owned by the given any object, for the given schema type
@@ -59,6 +62,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch> extends JAXRSS
/**
* Reads the attribute, owned by the given any object, for the given schema type and schema.
*
+ * Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter
+ * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+ *
* @param key any object key
* @param schemaType schema type
* @param schema schema
@@ -75,6 +81,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch> extends JAXRSS
/**
* Reads the any object matching the provided key.
*
+ * Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter
+ * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+ *
* @param key key of any object to be read
* @return any object with matching key
*/