com.adobe.cq.social.commons.comments.listing

Interface CommentSocialComponentList

All Superinterfaces:

java.util.Collection<java.lang.Object>, java.lang.Iterable<java.lang.Object>, java.util.List<java.lang.Object>

All Known Subinterfaces:

CalendarEventSocialComponentList, CommentSocialComponentQueryableList

public interface CommentSocialComponentList
extends java.util.List<java.lang.Object>

A collection of a comments. This interface is used by a CommentCollection, or a Comment to store its children.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEPTH Default embedded depth.

Method Summary

Modifier and Type	Method and Description
java.util.List<Comment>	getComments() Gets a strongly typed list of comments.
CollectionPagination	getPagination() Get the pagination setting.
int	getTotalSize() Get total size of the collection.
void	setPagination(CollectionPagination pagination) Set the collection pagination.
void	setPathConstraint(PathConstraintType pathConstraint) Set the path constraint to use in the search
void	setSortedOrder(CollectionSortedOrder sortedOrder) Set the sorted order of the list
void	setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_DEPTH

static final int DEFAULT_DEPTH

Default embedded depth.

See Also:

Constant Field Values

Method Detail

getTotalSize

int getTotalSize()

Get total size of the collection.

Returns:

total comments in the list

setPagination

void setPagination(CollectionPagination pagination)

Set the collection pagination.

Parameters:

pagination - the pagination settings for the output

setSortedOrder

void setSortedOrder(CollectionSortedOrder sortedOrder)

Set the sorted order of the list

Parameters:

sortedOrder - CollectionSortedOrder

getPagination

CollectionPagination getPagination()

Get the pagination setting.

Returns:

the pagination setting.

getComments

java.util.List<Comment> getComments()
                             throws RepositoryException

Gets a strongly typed list of comments.

Returns:

the list of comments managed by this list

Throws:

RepositoryException - RepositoryException

setPathConstraint

void setPathConstraint(PathConstraintType pathConstraint)

Set the path constraint to use in the search

Parameters:

pathConstraint - the path constraint to be used

setSortFields

void setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)