Package org.alfresco.rest.api.impl
Class GroupsImpl
java.lang.Object
org.alfresco.rest.api.impl.GroupsImpl
- All Implemented Interfaces:
Groups
Centralises access to groups services and maps between representations.
- Author:
- cturlica
-
Field Summary
FieldsFields inherited from interface org.alfresco.rest.api.Groups
PARAM_CASCADE, PARAM_DISPLAY_NAME, PARAM_ID, PARAM_INCLUDE_PARENT_IDS, PARAM_INCLUDE_ZONES, PARAM_IS_ROOT, PARAM_MEMBER_TYPE, PARAM_MEMBER_TYPE_GROUP, PARAM_MEMBER_TYPE_PERSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate
(Group group, Parameters parameters) Create a group.createGroupMember
(String groupId, GroupMember groupMember) Create a group member.void
delete
(String groupId, Parameters parameters) Delete the given group.void
deleteGroupMembership
(String groupId, String groupMemberId) Delete group membershipgetGroup
(String groupId, Parameters parameters) Get a group by it's id.getGroupMembers
(String groupId, Parameters parameters) Gets a list of groups.getGroups
(Parameters parameters) Gets a list of groups.getGroupsByPersonId
(String requestedPersonId, Parameters parameters) Gets the list of groups for which the specified person is a member.void
setAuthorityDAO
(AuthorityDAO authorityDAO) void
setAuthorityService
(AuthorityService authorityService) void
update
(String groupId, Group group, Parameters parameters) Update the given group.
-
Field Details
-
authorityService
-
people
-
-
Constructor Details
-
GroupsImpl
public GroupsImpl()
-
-
Method Details
-
getAuthorityService
-
setAuthorityService
-
setAuthorityDAO
-
setPeople
-
create
Description copied from interface:Groups
Create a group.- Specified by:
create
in interfaceGroups
- Parameters:
group
- the group to create.parameters
- theParameters
object to get the parameters passed into the request including: - include param (parentIds, zones)- Returns:
- a
org.alfresco.rest.api.model.Group
object
-
update
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 interfaceGroups
- Parameters:
groupId
- the group IDgroup
- details to use for the updateparameters
- theParameters
object to get the parameters passed into the request including: - include param (parentIds, zones)- Returns:
- Updated group
-
getGroup
Description copied from interface:Groups
Get a group by it's id.- Specified by:
getGroup
in interfaceGroups
- Parameters:
groupId
- the identifier of a group.parameters
- theParameters
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
Description copied from interface:Groups
Gets a list of groups.- Specified by:
getGroups
in interfaceGroups
- Parameters:
parameters
- theParameters
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 interfaceGroups
- Parameters:
requestedPersonId
- the person's ID ("-me-" may be used as an alias for the current user.)parameters
- theParameters
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
Description copied from interface:Groups
Delete the given group.- Specified by:
delete
in interfaceGroups
- Parameters:
groupId
- the group IDparameters
- theParameters
object to get the parameters passed into the request including: - include param (parentIds, zones)
-
getGroupMembers
Description copied from interface:Groups
Gets a list of groups.- Specified by:
getGroupMembers
in interfaceGroups
- Parameters:
groupId
- the identifier of a group.parameters
- theParameters
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
Description copied from interface:Groups
Create a group member.- Specified by:
createGroupMember
in interfaceGroups
- Parameters:
groupId
- the identifier of a group.- Returns:
- a
org.alfresco.rest.api.model.GroupMember
object
-
deleteGroupMembership
Description copied from interface:Groups
Delete group membership- Specified by:
deleteGroupMembership
in interfaceGroups
-