public interface Groups
Modifier and Type | Field and 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 |
Modifier and Type | Method and 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 membership
|
Group |
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.
|
static final String PARAM_ID
static final String PARAM_DISPLAY_NAME
static final String PARAM_INCLUDE_PARENT_IDS
static final String PARAM_INCLUDE_ZONES
static final String PARAM_IS_ROOT
static final String PARAM_CASCADE
static final String PARAM_MEMBER_TYPE
static final String PARAM_MEMBER_TYPE_GROUP
static final String PARAM_MEMBER_TYPE_PERSON
Group create(Group group, Parameters parameters)
group
- the group to create.parameters
- the Parameters
object to get the parameters passed into the request
including:
- include param (parentIds, zones)org.alfresco.rest.api.model.Group
objectGroup update(String groupId, Group group, Parameters parameters)
groupId
- the group IDgroup
- details to use for the updateparameters
- the Parameters
object to get the parameters passed
into the request including: - include param (parentIds, zones)Group getGroup(String groupId, Parameters parameters) throws EntityNotFoundException
groupId
- the identifier of a group.parameters
- the Parameters
object to get the parameters passed into the request
including:
- include param (parentIds, zones)org.alfresco.rest.api.model.Group
objectEntityNotFoundException
CollectionWithPagingInfo<Group> getGroups(Parameters 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)org.alfresco.rest.api.model.Group
objectsCollectionWithPagingInfo<Group> getGroupsByPersonId(String personId, Parameters 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 & paging params (orderBy, skipCount, maxItems)org.alfresco.rest.api.model.Group
objectsvoid delete(String groupId, Parameters parameters)
groupId
- the group IDparameters
- the Parameters
object to get the parameters passed
into the request including: - include param (parentIds, zones)CollectionWithPagingInfo<GroupMember> getGroupMembers(String groupId, Parameters 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)org.alfresco.rest.api.model.GroupMember
objectsGroupMember createGroupMember(String groupId, GroupMember groupMember)
groupId
- the identifier of a group.org.alfresco.rest.api.model.GroupMember
objectCopyright © 2005–2017 Alfresco Software. All rights reserved.