Package org.alfresco.rest.api

Interface Groups

All Known Implementing Classes:
GroupsImpl
public interface Groups
Groups API
Author:
cturlica

  • Field Details

  • Method Details

    • create

      Group create(Group group, Parameters parameters)
      Create a group.
      Parameters:
      group - the group to create.
      parameters - the Parameters object to get the parameters passed into the request including: - include param (parentIds, zones)
      Returns:
      a org.alfresco.rest.api.model.Group object

    • update

      Group update(String groupId, Group group, Parameters parameters)
      Update the given group. Not all fields are used, only those as defined in the Open API spec.
      Parameters:
      groupId - the group ID
      group - details to use for the update
      parameters - the Parameters object to get the parameters passed into the request including: - include param (parentIds, zones)
      Returns:
      Updated group

    • getGroup

      Group getGroup(String groupId, Parameters parameters) throws EntityNotFoundException
      Get a group by it's id.
      Parameters:
      groupId - the identifier of a group.
      parameters - the Parameters object to get the parameters passed into the request including: - include param (parentIds, zones)
      Returns:
      a org.alfresco.rest.api.model.Group object
      Throws:
      EntityNotFoundException

    • getGroups

      CollectionWithPagingInfo<Group> getGroups(Parameters parameters)
      Gets a list of groups.
      Parameters:
      parameters - the Parameters object to get the parameters passed into the request including: - filter, sort invalid input: '&' paging params (where, orderBy, skipCount, maxItems) - include param (parentIds, zones)
      Returns:
      a paged list of org.alfresco.rest.api.model.Group objects

    • getGroupsByPersonId

      CollectionWithPagingInfo<Group> getGroupsByPersonId(String personId, Parameters parameters)
      Gets the list of groups for which the specified person is a member.
      Parameters:
      personId - the person's ID ("-me-" may be used as an alias for the current user.)
      parameters - the Parameters object to get the parameters passed into the request including: - sort invalid input: '&' paging params (orderBy, skipCount, maxItems)
      Returns:
      a paged list of org.alfresco.rest.api.model.Group objects

    • delete

      void delete(String groupId, Parameters parameters)
      Delete the given group.
      Parameters:
      groupId - the group ID
      parameters - the Parameters object to get the parameters passed into the request including: - include param (parentIds, zones)

    • getGroupMembers

      CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, Parameters parameters)
      Gets a list of groups.
      Parameters:
      groupId - the identifier of a group.
      parameters - the Parameters object to get the parameters passed into the request including: - filter, sort invalid input: '&' paging params (where, orderBy, skipCount, maxItems) - include param (parentIds, zones)
      Returns:
      a paged list of org.alfresco.rest.api.model.GroupMember objects

    • createGroupMember

      GroupMember createGroupMember(String groupId, GroupMember groupMember)
      Create a group member.
      Parameters:
      groupId - the identifier of a group.
      Returns:
      a org.alfresco.rest.api.model.GroupMember object

    • deleteGroupMembership

      void deleteGroupMembership(String groupId, String groupMemberId)
      Delete group membership
      Parameters:
      groupId -
      groupMemberId -