com.sdl.delivery.ugc.client.comment

Interface UgcCommentApi

public interface UgcCommentApi

UGC client api to support creating/editing/deleting comments.

Method Summary

Modifier and Type	Method and Description
int	countFlatComments(CommentsFilter filter) Count comments that satisfy provided filtering parameters.
int	countFlatComments(String itemUri, CommentsFilter filter) Count comments that satisfy provided filtering parameters.
int	countFlatCommentsForPublication(long publicationId, CommentsFilter filter) Count comments that satisfy provided filtering parameters.
int	countThreadedComments(CommentsFilter filter) Count comments that satisfy provided filtering parameters.
int	countThreadedComments(long commentId, CommentsFilter filter) Count all child comments of the comment with passed commentId.
int	countThreadedComments(String itemUri, CommentsFilter filter) Count comments that satisfy provided filtering parameters.
int	countThreadedCommentsForPublication(long publicationId, CommentsFilter filter) Count comments that satisfy provided filtering parameters.
Comment	editComment(long editCommentId, String newCommentContent, com.sdl.web.ugc.Status status, Map<String,String> metadata) Edit existing ugc comment.
Comment	getCommentById(long commentId, boolean fetchMeta) Get the comment by id.
User	getUserById(String userId) Get user by id.
Comment	postComment(String itemUri, String username, String email, String commentContent, long parentCommentId, Map<String,String> metadata) Create new ugc comment.
void	removeComment(long commentId) Remove existing comment.
List<User>	retrieveAllUsers() Get all users.
List<Comment>	retrieveFlatComments(CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.
List<Comment>	retrieveFlatComments(String itemUri, CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.
List<Comment>	retrieveFlatCommentsForPublication(long publicationId, CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.
List<String>	retrieveMetadataValues(String key) Get the list of distinct metadata values for a given key.
List<Comment>	retrieveThreadedComments(CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.
List<Comment>	retrieveThreadedComments(long commentId, CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all child comments of the comment with passed commentId.
List<Comment>	retrieveThreadedComments(String itemUri, CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.
List<Comment>	retrieveThreadedCommentsForPublication(long publicationId, CommentsFilter filter, boolean orderDescending, boolean fetchMeta) Retrieve all comments that satisfy provided filtering parameters.

Method Detail

getCommentById

Comment getCommentById(long commentId,
                       boolean fetchMeta)

Get the comment by id.

Parameters:

commentId - the id of the comment.

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

the comment.

retrieveFlatComments

List<Comment> retrieveFlatComments(CommentsFilter filter,
                                   boolean orderDescending,
                                   boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. No comments hierarchy will be present.

Parameters:

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

retrieveFlatComments

List<Comment> retrieveFlatComments(String itemUri,
                                   CommentsFilter filter,
                                   boolean orderDescending,
                                   boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. No comments hierarchy will be present.

Parameters:

itemUri - the item uri to which the comments relates to

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

retrieveFlatCommentsForPublication

List<Comment> retrieveFlatCommentsForPublication(long publicationId,
                                                 CommentsFilter filter,
                                                 boolean orderDescending,
                                                 boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. No comments hierarchy will be present.

Parameters:

publicationId - the publication id to which the comments relates to

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

countFlatComments

int countFlatComments(CommentsFilter filter)

Count comments that satisfy provided filtering parameters. No comments hierarchy will be present. Top and Skip filters will be ignored.

Parameters:

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

countFlatComments

int countFlatComments(String itemUri,
                      CommentsFilter filter)

Count comments that satisfy provided filtering parameters. No comments hierarchy will be present. Top and Skip filters will be ignored.

Parameters:

itemUri - the item uri to which the comments relates to

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

countFlatCommentsForPublication

int countFlatCommentsForPublication(long publicationId,
                                    CommentsFilter filter)

Count comments that satisfy provided filtering parameters. No comments hierarchy will be present. Top and Skip filters will be ignored.

Parameters:

publicationId - the publicationId to which the comments relates to

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

retrieveThreadedComments

List<Comment> retrieveThreadedComments(CommentsFilter filter,
                                       boolean orderDescending,
                                       boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. Comments hierarchy is included.

Parameters:

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

retrieveThreadedComments

List<Comment> retrieveThreadedComments(String itemUri,
                                       CommentsFilter filter,
                                       boolean orderDescending,
                                       boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. Comments hierarchy is included.

Parameters:

itemUri - the item uri to which the comments relates to

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

retrieveThreadedCommentsForPublication

List<Comment> retrieveThreadedCommentsForPublication(long publicationId,
                                                     CommentsFilter filter,
                                                     boolean orderDescending,
                                                     boolean fetchMeta)

Retrieve all comments that satisfy provided filtering parameters. Comments hierarchy is included.

Parameters:

publicationId - the publicationId to which the comments relates to

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

list of comments that satisfy provided filtering parameters

countThreadedComments

int countThreadedComments(CommentsFilter filter)

Count comments that satisfy provided filtering parameters. Comments hierarchy is included. Top and Skip filters will be ignored.

Parameters:

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

countThreadedComments

int countThreadedComments(String itemUri,
                          CommentsFilter filter)

Count comments that satisfy provided filtering parameters. Comments hierarchy is included. Top and Skip filters will be ignored.

Parameters:

itemUri - the item uri to which the comments relates to

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

countThreadedCommentsForPublication

int countThreadedCommentsForPublication(long publicationId,
                                        CommentsFilter filter)

Count comments that satisfy provided filtering parameters. Comments hierarchy is included. Top and Skip filters will be ignored.

Parameters:

publicationId - the publication id to which the comments relates to

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

Returns:

the number of available comments

retrieveThreadedComments

List<Comment> retrieveThreadedComments(long commentId,
                                       CommentsFilter filter,
                                       boolean orderDescending,
                                       boolean fetchMeta)

Retrieve all child comments of the comment with passed commentId. Comments hierarchy is included.

Parameters:

commentId - parent comment id

filter - the filter for fetch operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

orderDescending - true if ordering status if desc, otherwise asc

fetchMeta - Flag indicates whether comments metadata will be fetched.

Returns:

a list of child comments

countThreadedComments

int countThreadedComments(long commentId,
                          CommentsFilter filter)

Count all child comments of the comment with passed commentId. Comments hierarchy is included. Top and Skip filters will be ignored.

Parameters:

commentId - parent comment id

filter - the filter for count operation. See com.sdl.delivery.ugc.client.comment.impl.SimpleCommentsFilter

postComment

Comment postComment(String itemUri,
                    String username,
                    String email,
                    String commentContent,
                    long parentCommentId,
                    Map<String,String> metadata)

Create new ugc comment. If the user already exists - username and email parameters are ignored.

Parameters:

itemUri - the item uri to which this comment relates to

username - the username of the user that is posting this comment. This parameter is ignored if the user already exists

email - the email of the user that is posting this comment. This parameter is ignored if the user already exists

commentContent - the comment content. Should not be null or empty

parentCommentId - the parent comment id, pass 0 if this is high level comment

metadata - the comment metadata

Returns:

created ugc comment

editComment

Comment editComment(long editCommentId,
                    String newCommentContent,
                    com.sdl.web.ugc.Status status,
                    Map<String,String> metadata)

Edit existing ugc comment.

Parameters:

editCommentId - the id of the existing comment

newCommentContent - the new comment content. If null or empty, the existing content will be reset to empty string.

status - the new comment status. If null is passed - RESUBMITTED status is used for edited comment

metadata - the comment metadata

Returns:

updated ugc comment

removeComment

void removeComment(long commentId)

Remove existing comment.

Parameters:

commentId - the id of the existing comment that has to be removed

retrieveMetadataValues

List<String> retrieveMetadataValues(String key)

Get the list of distinct metadata values for a given key.

Parameters:

key - the key name

Returns:

the list of values

getUserById

User getUserById(String userId)

Get user by id.

Parameters:

userId - the user Id

Returns:

the user

retrieveAllUsers

List<User> retrieveAllUsers()

Get all users.

Returns:

the list of users