com.gentics.contentnode.rest.resource
Interface GroupResource

All Superinterfaces:
AuthenticatedResource

public interface GroupResource
extends AuthenticatedResource

Resource to get groups


Method Summary
 GroupsResponse list(Integer skipCount, Integer maxItems, List<Integer> ids, List<String> names, List<String> memberLogins, List<Integer> memberIds, List<Integer> childGroupIds, List<Integer> privFolderIds, List<Privilege> privileges, GroupReduceType reduce, GroupSortAttribute sortBy, SortOrder sortOrder)
          Get a list of groups, optionally filtered sorted and paged.
 GroupsResponse load()
          Load the groups the user may see
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

load

GroupsResponse load()
Load the groups the user may see

Returns:
response containing groups

list

GroupsResponse list(Integer skipCount,
                    Integer maxItems,
                    List<Integer> ids,
                    List<String> names,
                    List<String> memberLogins,
                    List<Integer> memberIds,
                    List<Integer> childGroupIds,
                    List<Integer> privFolderIds,
                    List<Privilege> privileges,
                    GroupReduceType reduce,
                    GroupSortAttribute sortBy,
                    SortOrder sortOrder)
Get a list of groups, optionally filtered sorted and paged.

Parameters:
skipCount - number of groups skipped in the list (paging)
maxItems - maximum number of groups returned (paging)
ids - id of the group to return (filter)
names - name or name pattern of the group(s) to return (filter)
memberLogins - login name of the group member for the group(s) to return (filter)
memberIds - id of the group member for the group(s) to return (filter)
children - ids of child groups for the group(s) to return (filter)
sortBy - name of the sorted attribute (sorting)
sortOrder - sortorder (sorting)
Returns:
response containing the groups


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.