com.adobe.cq.social.members.endpoints

Interface CommunityMemberGroupProfileOperations

All Superinterfaces:

Operation

All Known Implementing Classes:

AbstractCommunityMemberGroupProfileOperationService

public interface CommunityMemberGroupProfileOperations
extends Operation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_GROUP_DESCRIPTION The prop group description.
static java.lang.String	PROP_GROUP_ID The prop group id.
static java.lang.String	PROP_GROUP_NAME The prop group name.
static java.lang.String	PROP_MEMBER_ID The prop member id.

Method Summary

Modifier and Type	Method and Description
Resource	addMember(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) Add member to a group representing by the specified resource.
Resource	addMember(SlingHttpServletRequest request) Add member to CommunityMemberGroup base on the specified SlingHttpServletRequest.
Resource	create(SlingHttpServletRequest request) Create a new CommunityMemberGroup base on the specified SlingHttpServletRequest.
Resource	createGroup(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) Add group representing by the specified resource.
SocialComponent	getSocialComponentForGroup(Resource group, SlingHttpServletRequest request) Get the SocialComponent for the specified Resource and SlingHttpServletRequest.
Resource	removeMember(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) Remove member from a group representing by the specified resource.
Resource	removeMember(SlingHttpServletRequest request) Remove member from CommunityMemberGroup base on the specified SlingHttpServletRequest.
Resource	update(Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParams, ClientUtilities clientUtils) Update a group representing by the specified resource.
Resource	update(SlingHttpServletRequest request) Update CommunityMemberGroup base on the specified SlingHttpServletRequest.

Field Detail

PROP_GROUP_ID

static final java.lang.String PROP_GROUP_ID

The prop group id.

See Also:

Constant Field Values

PROP_GROUP_NAME

static final java.lang.String PROP_GROUP_NAME

The prop group name.

See Also:

Constant Field Values

PROP_GROUP_DESCRIPTION

static final java.lang.String PROP_GROUP_DESCRIPTION

The prop group description.

See Also:

Constant Field Values

PROP_MEMBER_ID

static final java.lang.String PROP_MEMBER_ID

The prop member id.

See Also:

Constant Field Values

Method Detail

getSocialComponentForGroup

SocialComponent getSocialComponentForGroup(Resource group,
                                           SlingHttpServletRequest request)

Get the SocialComponent for the specified Resource and SlingHttpServletRequest.

Parameters:

group - the target group resource

request - the client request

Returns:

the SocialComponent

create

Resource create(SlingHttpServletRequest request)
         throws OperationException

Create a new CommunityMemberGroup base on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the new CommunityMemberGroup

Throws:

OperationException - if there is an error occurs

createGroup

Resource createGroup(Resource resource,
                     java.util.Map<java.lang.String,java.lang.Object> requestParams,
                     ClientUtilities clientUtils)
              throws OperationException

Add group representing by the specified resource.

Parameters:

resource - the resource belonging to a tenant.

requestParams - a map that contains the group id.

clientUtils - clientUtils

Returns:

Resource resource

Throws:

OperationException - operationException

addMember

Resource addMember(SlingHttpServletRequest request)
            throws OperationException

Add member to CommunityMemberGroup base on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the CommunityMemberGroup

Throws:

OperationException - if there is an error occurs

addMember

Resource addMember(Resource resource,
                   java.util.Map<java.lang.String,java.lang.Object> requestParams,
                   ClientUtilities clientUtils)
            throws OperationException

Add member to a group representing by the specified resource.

Parameters:

resource - the resource belonging to a tenant.

requestParams - a map that contains the group id and membersId.

clientUtils - clientUtils

Returns:

resource

Throws:

OperationException - operationException

removeMember

Resource removeMember(SlingHttpServletRequest request)
               throws OperationException

Remove member from CommunityMemberGroup base on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the CommunityMemberGroup

Throws:

OperationException - if there is an error occurs

removeMember

Resource removeMember(Resource resource,
                      java.util.Map<java.lang.String,java.lang.Object> requestParams,
                      ClientUtilities clientUtils)
               throws OperationException

Remove member from a group representing by the specified resource.

Parameters:

resource - the resource belonging to a tenant.

requestParams - a map that contains the group id and membersId.

clientUtils - clientUtils

Returns:

resource resource

Throws:

OperationException - operationException

update

Resource update(SlingHttpServletRequest request)
         throws OperationException

Update CommunityMemberGroup base on the specified SlingHttpServletRequest.

Parameters:

request - the client request

Returns:

the CommunityMemberGroup

Throws:

OperationException - if there is an error occurs

update

Resource update(Resource resource,
                java.util.Map<java.lang.String,java.lang.Object> requestParams,
                ClientUtilities clientUtils)
         throws OperationException

Update a group representing by the specified resource.

Parameters:

resource - the resource.

requestParams - a map that contains the groupId and membersId.

clientUtils - clientUtils

Returns:

Resource resource

Throws:

OperationException - operationException