com.adobe.cq.social.scf

Interface SocialCollectionComponent

All Superinterfaces:

SocialComponent

All Known Subinterfaces:

Asset<T>, Calendar, CalendarEvent, Comment<T>, CommentCollection<C,T>, CommunityAuthorizableCollection, CommunityGroupCollection, CommunityGroupMemberListComponent, CommunityMemberGroupCollection, CommunityMemberGroupMembers, CommunityMemberUserCollection, CommunitySimpleAuthorizableCollection, Document, EnablementAggregateResourceReport, EnablementGroupCollection, EnablementLearningPathResourceReport, EnablementLearningPathResources, EnablementLearningPathUserCompletionReport, EnablementLearningPathUserDetailReport, EnablementLearningPathUserEnrollmentReport, EnablementLearningPathView, EnablementLearningPathViewDetail, EnablementReportGroupEnrollmentList, EnablementReportUserEnrollmentList, EnablementResourceEnrollmentReport, EnablementResourceModelList, EnablementSiteAssignmentsView, EnablementSiteCatalog, EnablementSiteCatalogView, EnablementSiteCollection, FileLibrary<P,C>, Forum<P,C>, Journal, JournalEntryComment, JournalSidebar, MessageBoxSocialComponent<P,C>, MessageSocialComponent<T>, ModerationDashboard, Post<T>, QnaPost, QnaPostCollection, RelationshipCollection, ReviewCollectionSocialComponent<C,T>, ReviewSocialComponent<C>, SearchResultComponent, SocialNotificationCollection, TagCloud, UserChooserComponent

All Known Implementing Classes:

AbstractAsset, AbstractComment, AbstractCommentCollection, com.adobe.cq.social.user.api.AbstractCommunityAuthorizableCollection, AbstractCommunityGroupMemberListComponent, AbstractFileLibrary, AbstractForum, AbstractPost, AbstractRelationshipCollection, AbstractReview, AbstractReviewCollection, AbstractSocialNotificationCollection

public interface SocialCollectionComponent
extends SocialComponent

An object that represents a component that is primarily a collection of another component.

Field Summary

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getItems() Returns a list of children of this collection.
int	getTotalSize() Get total size of the collection.
void	setPagination(CollectionPagination pagination) Set the collection pagination to define how getItems() should be paginated.
void	setSortedOrder(CollectionSortedOrder sortedOrder) Set the collection sorted order.

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Method Detail

getTotalSize

int getTotalSize()

Get total size of the collection.

Returns:

the size of the collection.

setPagination

void setPagination(CollectionPagination pagination)

Set the collection pagination to define how getItems() should be paginated.

Parameters:

pagination - an object defining the how the list of items should be paginated.

setSortedOrder

void setSortedOrder(CollectionSortedOrder sortedOrder)

Set the collection sorted order.

Parameters:

sortedOrder - the order definition of how the items should be sorted.

getItems

java.util.List<java.lang.Object> getItems()

Returns a list of children of this collection. Use setPagination() to set pagination properties before calling this method.

Returns:

A List of children of this collection, or an empty list if no children are present. If the children is the first level child, then the child is embedded in the list, otherwise, the child url is included in the list.