com.adobe.cq.social.group.client.endpoints

Class AbstractCommunityGroupOperationService<T extends CommunityGroupOperationExtension,U extends Operation>

java.lang.Object

com.adobe.cq.social.scf.core.operations.AbstractOperationService<T,U,S>

com.adobe.cq.social.site.endpoints.AbstractPublishOperationService<T,U,CommunityGroup>

com.adobe.cq.social.group.client.endpoints.AbstractCommunityGroupOperationService<T,U>

Type Parameters:

T - is a CommunityGroupOperationExtension that will be used as hooks by the extending class.

U - is a Operation that is being provided by the extending class.

All Implemented Interfaces:

CommunityGroupOperations, OperationService<T,U,CommunityGroup>, com.adobe.cq.social.site.endpoints.PublishOperation

public abstract class AbstractCommunityGroupOperationService<T extends CommunityGroupOperationExtension,U extends Operation>
extends com.adobe.cq.social.site.endpoints.AbstractPublishOperationService<T,U,CommunityGroup>
implements CommunityGroupOperations

Provides abstract implementation of community group operations. This class can be extended to implement create operations for any component that extends the community group.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_FIELD_WHITELIST The name of the property that holds a white list of form field names added as additional properties to the comment.

Constructor Summary

Constructors

Constructor and Description
AbstractCommunityGroupOperationService()

Method Summary

Modifier and Type	Method and Description
boolean	approveJoin(ResourceResolver resolver, CommunityGroup group)
Resource	create(SlingHttpServletRequest request)
Resource	demoteMember(SlingHttpServletRequest request)
java.util.List<java.lang.Object>	getAllowedTemplateForEveryone(java.lang.String[] paths)
SocialComponent	getCommunityGroupComponentForResource(Resource communityGroup, SlingHttpServletRequest request) Get the SocialComponent for the specified Resource and SlingHttpServletRequest.
SocialComponent	getCommunityMemberListComponentForResource(Resource communityMembers, SlingHttpServletRequest request) Get the SocialComponent for the specified Resource and SlingHttpServletRequest.
Resource	invite(SlingHttpServletRequest request)
boolean	isPublishMode() Check if the aem instance is in publish mode
Resource	join(SlingHttpServletRequest request)
Resource	leave(SlingHttpServletRequest request)
Resource	promoteMember(SlingHttpServletRequest request)
Resource	uninvite(SlingHttpServletRequest request)
Resource	update(SlingHttpServletRequest request) Update the group with the specified parameters of the SlingHttpServletRequest

Methods inherited from class com.adobe.cq.social.site.endpoints.AbstractPublishOperationService

publish, unpublish

Methods inherited from class com.adobe.cq.social.scf.core.operations.AbstractOperationService

addOperationExtension, getInheritedOperationExtensionManager, performAfterActions, performBeforeActions, removeOperationExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.site.endpoints.PublishOperation

publish, unpublish

Field Detail

PROPERTY_FIELD_WHITELIST

public static final java.lang.String PROPERTY_FIELD_WHITELIST

The name of the property that holds a white list of form field names added as additional properties to the comment.

See Also:

Constant Field Values

Constructor Detail

AbstractCommunityGroupOperationService

public AbstractCommunityGroupOperationService()

Method Detail

create

public Resource create(SlingHttpServletRequest request)
                throws OperationException

Specified by:

create in interface CommunityGroupOperations

Throws:

OperationException

update

public Resource update(SlingHttpServletRequest request)
                throws OperationException

Description copied from interface: CommunityGroupOperations

Update the group with the specified parameters of the SlingHttpServletRequest

Specified by:

update in interface CommunityGroupOperations

Parameters:

request - SlingHttpServletRequest.

Returns:

resource.

Throws:

OperationException - - throws if not able to update.

isPublishMode

public boolean isPublishMode()

Description copied from interface: CommunityGroupOperations

Check if the aem instance is in publish mode

Specified by:

isPublishMode in interface CommunityGroupOperations

Returns:

true if published mode

approveJoin

public boolean approveJoin(ResourceResolver resolver,
                           CommunityGroup group)
                    throws OperationException

Specified by:

approveJoin in interface CommunityGroupOperations

Throws:

OperationException

join

public Resource join(SlingHttpServletRequest request)
              throws OperationException

Specified by:

join in interface CommunityGroupOperations

Throws:

OperationException

leave

public Resource leave(SlingHttpServletRequest request)
               throws OperationException

Specified by:

leave in interface CommunityGroupOperations

Throws:

OperationException

invite

public Resource invite(SlingHttpServletRequest request)
                throws OperationException

Specified by:

invite in interface CommunityGroupOperations

Throws:

OperationException

uninvite

public Resource uninvite(SlingHttpServletRequest request)
                  throws OperationException

Specified by:

uninvite in interface CommunityGroupOperations

Throws:

OperationException

promoteMember

public Resource promoteMember(SlingHttpServletRequest request)
                       throws OperationException

Specified by:

promoteMember in interface CommunityGroupOperations

Throws:

OperationException

demoteMember

public Resource demoteMember(SlingHttpServletRequest request)
                      throws OperationException

Specified by:

demoteMember in interface CommunityGroupOperations

Throws:

OperationException

getAllowedTemplateForEveryone

public java.util.List<java.lang.Object> getAllowedTemplateForEveryone(java.lang.String[] paths)

Specified by:

getAllowedTemplateForEveryone in interface CommunityGroupOperations

getCommunityGroupComponentForResource

public SocialComponent getCommunityGroupComponentForResource(Resource communityGroup,
                                                             SlingHttpServletRequest request)

Get the SocialComponent for the specified Resource and SlingHttpServletRequest.

Specified by:

getCommunityGroupComponentForResource in interface CommunityGroupOperations

Parameters:

communityGroup - the target community group

request - the client request

Returns:

the SocialComponent

getCommunityMemberListComponentForResource

public SocialComponent getCommunityMemberListComponentForResource(Resource communityMembers,
                                                                  SlingHttpServletRequest request)

Get the SocialComponent for the specified Resource and SlingHttpServletRequest.

Specified by:

getCommunityMemberListComponentForResource in interface CommunityGroupOperations

Parameters:

communityMembers - the target community member list

request - the client request

Returns:

the SocialComponent