mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
REPO-1301: Retrieve a group
- first commit git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@133709 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
@@ -27,6 +27,7 @@ package org.alfresco.rest.api;
|
||||
|
||||
import org.alfresco.rest.api.model.Group;
|
||||
import org.alfresco.rest.api.model.GroupMember;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
|
||||
@@ -46,13 +47,25 @@ public interface Groups
|
||||
String PARAM_MEMBER_TYPE_GROUP = "GROUP";
|
||||
String PARAM_MEMBER_TYPE_PERSON = "PERSON";
|
||||
|
||||
/**
|
||||
* Get a group by it's id.
|
||||
*
|
||||
* @param groupId the identifier of a group.
|
||||
* @param parameters the {@link Parameters} object to get the parameters passed into the request
|
||||
* including:
|
||||
* - include param (parentIds, zones)
|
||||
* @return a {@code org.alfresco.rest.api.model.Group} object
|
||||
* @throws EntityNotFoundException
|
||||
*/
|
||||
Group getGroup(String groupId, Parameters parameters) throws EntityNotFoundException;
|
||||
|
||||
/**
|
||||
* Gets a list of groups.
|
||||
*
|
||||
* @param parameters the {@link Parameters} object to get the parameters passed into the request
|
||||
* including:
|
||||
* - filter, sort & paging params (where, orderBy, skipCount, maxItems)
|
||||
* - incFiles, incFolders (both true by default)
|
||||
* - include param (parentIds, zones)
|
||||
* @return a paged list of {@code org.alfresco.rest.api.model.Group} objects
|
||||
*/
|
||||
CollectionWithPagingInfo<Group> getGroups(Parameters parameters);
|
||||
@@ -64,7 +77,7 @@ public interface Groups
|
||||
* @param parameters the {@link Parameters} object to get the parameters passed into the request
|
||||
* including:
|
||||
* - filter, sort & paging params (where, orderBy, skipCount, maxItems)
|
||||
* - incFiles, incFolders (both true by default)
|
||||
* - include param (parentIds, zones)
|
||||
* @return a paged list of {@code org.alfresco.rest.api.model.GroupMember} objects
|
||||
*/
|
||||
CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, Parameters parameters);
|
||||
|
Reference in New Issue
Block a user