com.adobe.cq.social.commons.comments.endpoints

Interface CommentOperations

All Known Subinterfaces:

CalendarOperations, FileLibraryOperations, ForumOperations, JournalOperations, MessagingOperations, QnaForumOperations, ReviewOperations, TranslationOperations

@ProviderType
public interface CommentOperations

CRUD Operation of a Comment.

Method Summary

Modifier and Type	Method and Description
Resource	changeState(Resource root, java.lang.String author, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session) Change state of a comment with the specified Map of properties and List of attachments.
Resource	changeState(SlingHttpServletRequest request, Session session) Change state of a comment base on the specified SlingHttpServletRequest using the specified Session.
Resource	create(Resource root, java.lang.String author, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session) Create a comment with the specified Map of properties and List of attachments.
Resource	create(SlingHttpServletRequest request, Session session) Create a new comment base on the specified SlingHttpServletRequest using the specified Session.
void	delete(Resource commentResource, Session session) Delete a Comment using the specified Session.
void	delete(Resource commentResource, Session session, java.util.Map<java.lang.String,java.lang.Object> conditionals) Delete a Comment using the specified Session.
void	delete(SlingHttpServletRequest request, Session session) Delete a Comment specified by the SlingHttpServletRequest using the specified Session.
void	delete(SlingHttpServletRequest request, Session session, java.util.Map<java.lang.String,java.lang.Object> conditionals) Delete a Comment specified by the SlingHttpServletRequest using the specified Session.
Resource	move(Resource commentResource, Resource parentResource, Session session) Move the provided resource onto the provided parent resource
Resource	move(SlingHttpServletRequest request, Session session) Perform a move operation.
void	removeAttachment(Resource commentResource, java.lang.String attachment, Session session) Removes attachment from comment if the user has privileges to do so
void	removeAttachment(SlingHttpServletRequest request, Session session) Removes attachment from comment if the user has privileges to do so.
Resource	update(Resource commentResource, java.util.Map<java.lang.String,java.lang.Object> props, java.util.List<javax.activation.DataSource> attachments, Session session) Update the specified comment with the specified Map of properties and List of attachments.
Resource	update(SlingHttpServletRequest request, Session session) Update a Comment base on the specified SlingHttpServletRequest using the specified.
Resource	uploadImage(SlingHttpServletRequest request, Session session) Upload image.

Method Detail

create

Resource create(SlingHttpServletRequest request,
                Session session)
         throws OperationException

Create a new comment base on the specified SlingHttpServletRequest using the specified Session.

Parameters:

request - the client request

session - the user session to be used to create the new comment

Returns:

the new Comment

Throws:

OperationException - if there is an error occurs

create

Resource create(Resource root,
                java.lang.String author,
                java.util.Map<java.lang.String,java.lang.Object> props,
                java.util.List<javax.activation.DataSource> attachments,
                Session session)
         throws OperationException

Create a comment with the specified Map of properties and List of attachments.

Parameters:

root - the root resource of the comment to be created

author - the user name

props - a list of properties for the new comment

attachments - a list of comment attachments

session - the user session to be used to create the new comment

Returns:

the new Comment

Throws:

OperationException - if there is an error occurs

update

Resource update(SlingHttpServletRequest request,
                Session session)
         throws OperationException

Update a Comment base on the specified SlingHttpServletRequest using the specified. Session.

Parameters:

request - the request

session - the session

Returns:

the update comment

Throws:

OperationException - if there is an error occurs

update

Resource update(Resource commentResource,
                java.util.Map<java.lang.String,java.lang.Object> props,
                java.util.List<javax.activation.DataSource> attachments,
                Session session)
         throws OperationException

Update the specified comment with the specified Map of properties and List of attachments.

Parameters:

commentResource - the target comment

props - a map of the properties to be updated

attachments - a list of attachment to be added to the specified comment

session - the user session to be used to perform the operation

Returns:

the new updated comment

Throws:

OperationException - if there is an error occurs

uploadImage

Resource uploadImage(SlingHttpServletRequest request,
                     Session session)
              throws OperationException

Upload image.

Parameters:

request - the request

session - the session

Returns:

the resource of the image

Throws:

OperationException - if an error occurs

delete

void delete(SlingHttpServletRequest request,
            Session session)
     throws OperationException

Delete a Comment specified by the SlingHttpServletRequest using the specified Session.

Parameters:

request - the http request which specifies the target comment

session - the user session to be used to perform the operation

Throws:

OperationException - if there is an error occurs

delete

void delete(SlingHttpServletRequest request,
            Session session,
            java.util.Map<java.lang.String,java.lang.Object> conditionals)
     throws OperationException

Delete a Comment specified by the SlingHttpServletRequest using the specified Session.

Parameters:

request - the http request which specifies the target comment

session - the user session to be used to perform the operation

conditionals - params deciding execution flow

Throws:

OperationException - if there is an error occurs

delete

void delete(Resource commentResource,
            Session session)
     throws OperationException

Delete a Comment using the specified Session.

Parameters:

commentResource - the target comment

session - the user session to be used to delete the specified comment.

Throws:

OperationException - if there is an error occurs

delete

void delete(Resource commentResource,
            Session session,
            java.util.Map<java.lang.String,java.lang.Object> conditionals)
     throws OperationException

Delete a Comment using the specified Session.

Parameters:

commentResource - the target comment

session - the user session to be used to delete the specified comment.

conditionals - params deciding execution flow

Throws:

OperationException - if there is an error occurs

changeState

Resource changeState(SlingHttpServletRequest request,
                     Session session)
              throws OperationException

Change state of a comment base on the specified SlingHttpServletRequest using the specified Session.

Parameters:

request - the client request

session - the user session to be used to change comment state

Returns:

the new Comment

Throws:

OperationException - if there is an error occurs

changeState

Resource changeState(Resource root,
                     java.lang.String author,
                     java.util.Map<java.lang.String,java.lang.Object> props,
                     java.util.List<javax.activation.DataSource> attachments,
                     Session session)
              throws OperationException

Change state of a comment with the specified Map of properties and List of attachments.

Parameters:

root - the root resource of the comment to be changed

author - the user name

props - a list of properties for the comment

attachments - a list of comment attachments

session - the user session to be used to change the comment's state

Returns:

the new Comment

Throws:

OperationException - if there is an error occurs

move

Resource move(SlingHttpServletRequest request,
              Session session)
       throws OperationException

Perform a move operation. Required parameters from the request are: 1. "resourcePath" - the path pointing to the resource being moved 2. "parentPath" - the path pointing to the new target parent resource

Parameters:

request - the request

session - the session

Returns:

the resource after the move

Throws:

OperationException - OperationException

move

Resource move(Resource commentResource,
              Resource parentResource,
              Session session)
       throws OperationException

Move the provided resource onto the provided parent resource

Parameters:

commentResource - the resource being moved

parentResource - the target parent resource

session - the session

Returns:

the resource after the move

Throws:

OperationException - OperationException

removeAttachment

void removeAttachment(SlingHttpServletRequest request,
                      Session session)
               throws OperationException

Removes attachment from comment if the user has privileges to do so. new target parent resource

Parameters:

request - the request

session - the session

Throws:

OperationException - OperationException

removeAttachment

void removeAttachment(Resource commentResource,
                      java.lang.String attachment,
                      Session session)
               throws OperationException

Removes attachment from comment if the user has privileges to do so

Parameters:

commentResource - the resource being moved

attachment - the attachment to be removed

session - the session

Throws:

OperationException - OperationException