ALF-11378: REST API has been modified to return extra information about a user whether s/he belongs to a group or not.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@41906 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Jamal Kaabi-Mofrad
2012-09-24 15:36:02 +00:00
parent f67f4919f9
commit 0789d8d01d
7 changed files with 326 additions and 65 deletions

View File

@@ -0,0 +1,57 @@
/*
* Copyright (C) 2005-2012 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.service.cmr.site;
/**
* Site member's information. The member can either be an individual or a group.
*
* @author Jamal Kaabi-Mofrad
* @since odin
*/
public interface SiteMemberInfo
{
/**
* Get the member's name. The name can either be the name of an individual
* or a group
*
* @return String member's name
*/
public String getMemberName();
/**
* Get the member's role
*
* @return String member's role
*/
public String getMemberRole();
/**
* Indicates whether a member belongs to a group with access rights to the
* site or not
*
* @return <tt>true</tt> if the member belongs to a group with access
* rights, otherwise <tt>false</tt>
*/
public boolean isMemberOfGroup();
}

View File

@@ -246,6 +246,21 @@ public interface SiteService
@NotAuditable
Map<String, String> listMembers(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups);
/**
* List the members of the site. This includes both users and groups if collapseGroups is set to false, otherwise all
* groups that are members are collapsed into their component users and listed.
*
*
* @param shortName site short name
* @param nameFilter name filter
* @param roleFilter role filter
* @param size max results size crop if >0
* @param collapseGroups true if collapse member groups into user list, false otherwise
* @return List of site authorities information objects
*/
@NotAuditable
List<SiteMemberInfo> listMembersInfo(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups);
/**
* Gets the role of the specified user.
*