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

Interface CommentOperations

All Known Subinterfaces:

ForumOperations, ReviewOperations

public interface CommentOperations

CRUD Operation of a Comment.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	create(Resource root, String author, Map<String,Object> props, 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(SlingHttpServletRequest request, Session session) Delete a Comment specified by the SlingHttpServletRequest using the specified Session.
Resource	update(Resource commentResource, Map<String,Object> props, 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.

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,
              String author,
              Map<String,Object> props,
              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 -

session -

Returns:

the update comment

Throws:

OperationException - if there is an error occurs

update

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

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

Parameters:

comment - 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

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(Resource commentResource,
          Session session)
            throws OperationException

Delete a Comment using the specified Session.

Parameters:

comment - the target comment

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

Throws:

OperationException - if there is an error occurs