Package org.alfresco.rest.api
Interface Groups
-
- All Known Implementing Classes:
GroupsImpl
public interface Groups
Groups API- Author:
- cturlica
-
-
Field Summary
Fields Modifier and Type Field Description static String
PARAM_CASCADE
static String
PARAM_DISPLAY_NAME
static String
PARAM_ID
static String
PARAM_INCLUDE_PARENT_IDS
static String
PARAM_INCLUDE_ZONES
static String
PARAM_IS_ROOT
static String
PARAM_MEMBER_TYPE
static String
PARAM_MEMBER_TYPE_GROUP
static String
PARAM_MEMBER_TYPE_PERSON
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Group
create(Group group, Parameters parameters)
Create a group.GroupMember
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 membershipGroup
getGroup(String groupId, Parameters parameters)
Get a group by it's id.CollectionWithPagingInfo<GroupMember>
getGroupMembers(String groupId, Parameters parameters)
Gets a list of groups.CollectionWithPagingInfo<Group>
getGroups(Parameters parameters)
Gets a list of groups.CollectionWithPagingInfo<Group>
getGroupsByPersonId(String personId, Parameters parameters)
Gets the list of groups for which the specified person is a member.Group
update(String groupId, Group group, Parameters parameters)
Update the given group.
-
-
-
Field Detail
-
PARAM_ID
static final String PARAM_ID
- See Also:
- Constant Field Values
-
PARAM_DISPLAY_NAME
static final String PARAM_DISPLAY_NAME
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_PARENT_IDS
static final String PARAM_INCLUDE_PARENT_IDS
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_ZONES
static final String PARAM_INCLUDE_ZONES
- See Also:
- Constant Field Values
-
PARAM_IS_ROOT
static final String PARAM_IS_ROOT
- See Also:
- Constant Field Values
-
PARAM_CASCADE
static final String PARAM_CASCADE
- See Also:
- Constant Field Values
-
PARAM_MEMBER_TYPE
static final String PARAM_MEMBER_TYPE
- See Also:
- Constant Field Values
-
PARAM_MEMBER_TYPE_GROUP
static final String PARAM_MEMBER_TYPE_GROUP
- See Also:
- Constant Field Values
-
PARAM_MEMBER_TYPE_PERSON
static final String PARAM_MEMBER_TYPE_PERSON
- See Also:
- Constant Field Values
-
-
Method Detail
-
create
Group create(Group group, Parameters parameters)
Create a group.- 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
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 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
Group getGroup(String groupId, Parameters parameters) throws EntityNotFoundException
Get a group by it's id.- 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
CollectionWithPagingInfo<Group> getGroups(Parameters parameters)
Gets a list of groups.- 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
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
- 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
void delete(String groupId, Parameters parameters)
Delete the given group.- Parameters:
groupId
- the group IDparameters
- theParameters
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
- 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
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
-
-