com.adobe.cq.social.commons.moderation.api

Interface ModerationOperations

public interface ModerationOperations

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISPLAY_FLAG_REASON_BOX

Method Summary

Modifier and Type	Method and Description
void	allow(java.util.List<Resource> resourceList, Session session, ResourceResolver resourceResolver) Process a bulk comment allow request sent by a client.
void	allow(Resource resource, Session session, java.lang.String userId) Process an allow request sent by a client.
void	close(java.util.List<Resource> resourceList, Session session, ResourceResolver resolver, boolean close) Process a bulk close/open request sent by a client.
void	close(Resource sessionResource, Session session, boolean close) Process a close/open request sent by a client.
void	delete(java.util.List<Resource> resourceList, Session session, ResourceResolver resourceResolver) Process a bulk comment delete request sent by a client.
void	delete(Resource resource, Session session, ResourceResolver resourceResolver) Process a delete request sent by a client.
void	deny(java.util.List<Resource> resourceList, Session session, ResourceResolver resourceResolver) Process a bulk comment deny request sent by a client.
void	deny(Resource resource, Session session) Process a comment deny request sent by a client.
void	flag(Resource resource, java.lang.String flagReason, boolean doFlag, java.lang.String userId) Process a comment flag request sent by a client.
void	pin(java.util.List<Resource> resourceList, Session session, ResourceResolver resolver, boolean pin) Process a bulk pin/unpin request sent by a client.
void	pin(Resource sessionResource, Session session, boolean pin) Process a pin/unpin request sent by a client.
void	toggleFeatured(java.util.List<Resource> resourceList, Session session, ResourceResolver resolver, boolean markFeatured) Process a bulk Feature / unFeature request sent by a client.
void	toggleFeatured(Resource sessionResource, Session session, boolean markFeatured) Process a Feature / unFeature request sent by a client.

Field Detail

DISPLAY_FLAG_REASON_BOX

static final java.lang.String DISPLAY_FLAG_REASON_BOX

See Also:

Constant Field Values

Method Detail

deny

void deny(Resource resource,
          Session session)
   throws com.adobe.cq.social.commons.CommentException

Process a comment deny request sent by a client.

Parameters:

resource - the resource to deny

session - the session used to deny

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

deny

void deny(java.util.List<Resource> resourceList,
          Session session,
          ResourceResolver resourceResolver)
   throws com.adobe.cq.social.commons.CommentException

Process a bulk comment deny request sent by a client.

Parameters:

resourceList - an array of resources to deny

session - the user session requesting the bulk deny

resourceResolver - the resource resolver

Throws:

com.adobe.cq.social.commons.CommentException - for any exception, including when the session cannot save the change

flag

void flag(Resource resource,
          java.lang.String flagReason,
          boolean doFlag,
          java.lang.String userId)
   throws com.adobe.cq.social.commons.CommentException,
          OperationException

Process a comment flag request sent by a client.

Parameters:

resource - the resource to flag

flagReason - the reason the UGC is being flagged for moderation

doFlag - flag if true, remove a flag if false

userId - the id of the user flagging the comment

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

OperationException - when the flag action can't be performed on resource

allow

void allow(Resource resource,
           Session session,
           java.lang.String userId)
    throws com.adobe.cq.social.commons.CommentException

Process an allow request sent by a client. Sets the UGC status back to okay.

Parameters:

resource - the resource to allow

session - the session used to allow

userId - id of the originating user

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

allow

void allow(java.util.List<Resource> resourceList,
           Session session,
           ResourceResolver resourceResolver)
    throws com.adobe.cq.social.commons.CommentException

Process a bulk comment allow request sent by a client.

Parameters:

resourceList - an array of resources to allow

session - the user session requesting the bulk allow

resourceResolver - the resource resolver

Throws:

com.adobe.cq.social.commons.CommentException - for any exception, including when the session cannot save the change

close

void close(Resource sessionResource,
           Session session,
           boolean close)

Process a close/open request sent by a client.

Parameters:

sessionResource - the resource to close

session - the session used to close

close - true if the request is to close content, false if it is to open.

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

close

void close(java.util.List<Resource> resourceList,
           Session session,
           ResourceResolver resolver,
           boolean close)

Process a bulk close/open request sent by a client.

Parameters:

resourceList - an array of resources to close

session - the session used to close

resolver - ResourceResolver

close - true if the request is to close content, false if it is to open.

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

pin

void pin(Resource sessionResource,
         Session session,
         boolean pin)

Process a pin/unpin request sent by a client.

Parameters:

sessionResource - the resource to pin

session - the session used to pin

pin - true if the request is to pin content, false if it is to unpin.

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

pin

void pin(java.util.List<Resource> resourceList,
         Session session,
         ResourceResolver resolver,
         boolean pin)

Process a bulk pin/unpin request sent by a client.

Parameters:

resourceList - an array of resources to pin

session - the session used to pin

resolver - ResourceResolver

pin - true if the request is to pin content, false if it is to unpin.

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

delete

void delete(Resource resource,
            Session session,
            ResourceResolver resourceResolver)
     throws com.adobe.cq.social.commons.CommentException

Process a delete request sent by a client. Sets the UGC status back to okay.

Parameters:

resource - the resource to delete

session - the session used to delete

resourceResolver - the resource resolver

Throws:

com.adobe.cq.social.commons.CommentException - when the session cannot save the changes in the comment system

delete

void delete(java.util.List<Resource> resourceList,
            Session session,
            ResourceResolver resourceResolver)
     throws com.adobe.cq.social.commons.CommentException

Process a bulk comment delete request sent by a client.

Parameters:

resourceList - an array of resources to delete

session - the user session requesting the bulk delete

resourceResolver - the resource resolver

Throws:

com.adobe.cq.social.commons.CommentException - for any exception, including when the session cannot save the change

toggleFeatured

void toggleFeatured(Resource sessionResource,
                    Session session,
                    boolean markFeatured)

Process a Feature / unFeature request sent by a client.

Parameters:

sessionResource - - the resource to Feature / unFeature

session - - the session used to Feature / unFeature

markFeatured - - true if the request is to mark a content as featured, false if it is to unFeature.

Throws:

com.adobe.cq.social.commons.CommentException - - when the session cannot save the changes in the comment system

toggleFeatured

void toggleFeatured(java.util.List<Resource> resourceList,
                    Session session,
                    ResourceResolver resolver,
                    boolean markFeatured)

Process a bulk Feature / unFeature request sent by a client.

Parameters:

resourceList - an array of resources to Feature / unFeature

session - - the session used to Feature / unFeature

resolver - ResourceResolver

markFeatured - - true if the request is to mark a content as featured, false if it is to unFeature.

Throws:

com.adobe.cq.social.commons.CommentException - - when the session cannot save the changes in the comment system