Class GroupsImpl

java.lang.Object
org.alfresco.rest.api.impl.GroupsImpl
All Implemented Interfaces:
Groups

public class GroupsImpl extends Object implements Groups
Centralises access to groups services and maps between representations.
Author:
cturlica
  • Field Details

  • Constructor Details

    • GroupsImpl

      public GroupsImpl()
  • Method Details

    • getAuthorityService

      public AuthorityService getAuthorityService()
    • setAuthorityService

      public void setAuthorityService(AuthorityService authorityService)
    • setAuthorityDAO

      public void setAuthorityDAO(AuthorityDAO authorityDAO)
    • setPeople

      public void setPeople(People people)
    • create

      public Group create(Group group, Parameters parameters)
      Description copied from interface: Groups
      Create a group.
      Specified by:
      create in interface Groups
      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

      public Group update(String groupId, Group group, Parameters parameters)
      Description copied from interface: Groups
      Update the given group. Not all fields are used, only those as defined in the Open API spec.
      Specified by:
      update in interface Groups
      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

      public Group getGroup(String groupId, Parameters parameters) throws EntityNotFoundException
      Description copied from interface: Groups
      Get a group by it's id.
      Specified by:
      getGroup in interface Groups
      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

      public CollectionWithPagingInfo<Group> getGroups(Parameters parameters)
      Description copied from interface: Groups
      Gets a list of groups.
      Specified by:
      getGroups in interface Groups
      Parameters:
      parameters - the Parameters object to get the parameters passed into the request including: - filter, sort & paging params (where, orderBy, skipCount, maxItems) - include param (parentIds, zones)
      Returns:
      a paged list of org.alfresco.rest.api.model.Group objects
    • getGroupsByPersonId

      public CollectionWithPagingInfo<Group> getGroupsByPersonId(String requestedPersonId, Parameters parameters)
      Description copied from interface: Groups
      Gets the list of groups for which the specified person is a member.
      Specified by:
      getGroupsByPersonId in interface Groups
      Parameters:
      requestedPersonId - 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 & paging params (orderBy, skipCount, maxItems)
      Returns:
      a paged list of org.alfresco.rest.api.model.Group objects
    • delete

      public void delete(String groupId, Parameters parameters)
      Description copied from interface: Groups
      Delete the given group.
      Specified by:
      delete in interface Groups
      Parameters:
      groupId - the group ID
      parameters - the Parameters object to get the parameters passed into the request including: - include param (parentIds, zones)
    • getGroupMembers

      public CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, Parameters parameters)
      Description copied from interface: Groups
      Gets a list of groups.
      Specified by:
      getGroupMembers in interface Groups
      Parameters:
      groupId - the identifier of a group.
      parameters - the Parameters object to get the parameters passed into the request including: - filter, sort & paging params (where, orderBy, skipCount, maxItems) - include param (parentIds, zones)
      Returns:
      a paged list of org.alfresco.rest.api.model.GroupMember objects
    • createGroupMember

      public GroupMember createGroupMember(String groupId, GroupMember groupMember)
      Description copied from interface: Groups
      Create a group member.
      Specified by:
      createGroupMember in interface Groups
      Parameters:
      groupId - the identifier of a group.
      Returns:
      a org.alfresco.rest.api.model.GroupMember object
    • deleteGroupMembership

      public void deleteGroupMembership(String groupId, String groupMemberId)
      Description copied from interface: Groups
      Delete group membership
      Specified by:
      deleteGroupMembership in interface Groups