Package org.alfresco.rest.requests

Class Groups

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Groups>

org.alfresco.rest.requests.Groups

public class Groups
extends ModelRequest<Groups>

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
Groups(RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestGroupsModel	createGroup(java.lang.String groupBodyCreate)	Create a group using POST on '/groups
RestGroupMember	createGroupMembership(java.lang.String groupId, java.lang.String groupMembershipBodyCreate)	Create a group membership using POST on '/groups/{groupId}/members
void	deleteGroup(java.lang.String groupId)	Delete a group using DELETE on '/groups/{groupId}
void	deleteGroupMembership(java.lang.String groupId, java.lang.String groupMemberId)	Delete a group membership using DELETE on '/groups/{groupId}/members/{groupMemberId}
RestGroupsModel	getGroupDetail(java.lang.String groupId)	Retrieve group details using GET on '/groups/{groupId}
RestGroupMemberModelsCollection	listGroupMemberships(java.lang.String groupId)	List memberships of a group using GET on '/groups/{groupId}/members
RestGroupsModelsCollection	listGroups()	List existing groups using GET on '/groups
RestGroupsModel	updateGroupDetails(java.lang.String groupId, java.lang.String groupBodyUpdate)	Update group details using PUT on '/groups/{groupId}

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Groups

public Groups(RestWrapper restWrapper)

Method Detail

listGroups

public RestGroupsModelsCollection listGroups()
                                      throws java.lang.Exception

List existing groups using GET on '/groups

Throws:

java.lang.Exception

createGroup

public RestGroupsModel createGroup(java.lang.String groupBodyCreate)
                            throws java.lang.Exception

Create a group using POST on '/groups

Throws:

java.lang.Exception

getGroupDetail

public RestGroupsModel getGroupDetail(java.lang.String groupId)
                               throws java.lang.Exception

Retrieve group details using GET on '/groups/{groupId}

Throws:

java.lang.Exception

deleteGroup

public void deleteGroup(java.lang.String groupId)
                 throws java.lang.Exception

Delete a group using DELETE on '/groups/{groupId}

Throws:

java.lang.Exception

updateGroupDetails

public RestGroupsModel updateGroupDetails(java.lang.String groupId,
                                          java.lang.String groupBodyUpdate)
                                   throws java.lang.Exception

Update group details using PUT on '/groups/{groupId}

Throws:

java.lang.Exception

listGroupMemberships

public RestGroupMemberModelsCollection listGroupMemberships(java.lang.String groupId)
                                                     throws java.lang.Exception

List memberships of a group using GET on '/groups/{groupId}/members

Throws:

java.lang.Exception

createGroupMembership

public RestGroupMember createGroupMembership(java.lang.String groupId,
                                             java.lang.String groupMembershipBodyCreate)
                                      throws java.lang.Exception

Create a group membership using POST on '/groups/{groupId}/members

Throws:

java.lang.Exception

deleteGroupMembership

public void deleteGroupMembership(java.lang.String groupId,
                                  java.lang.String groupMemberId)
                           throws java.lang.Exception

Delete a group membership using DELETE on '/groups/{groupId}/members/{groupMemberId}

Throws:

java.lang.Exception