com.adobe.cq.social.graph.client.api

Class AbstractRelationshipCollection

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.graph.client.api.AbstractRelationshipCollection

All Implemented Interfaces:

RelationshipCollection, SocialCollectionComponent, SocialComponent

public class AbstractRelationshipCollection
extends BaseSocialComponent
implements RelationshipCollection

Return list of INCOMING or OUTGOING relationship of the user session.

Field Summary

Fields inherited from interface com.adobe.cq.social.graph.client.api.RelationshipCollection

RESOURCE_TYPE

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractRelationshipCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo requestInfo)

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 class com.adobe.cq.social.scf.core.BaseSocialComponent

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

AbstractRelationshipCollection

public AbstractRelationshipCollection(Resource resource,
                                      ClientUtilities clientUtils,
                                      QueryRequestInfo requestInfo)

Method Detail

getTotalSize

public int getTotalSize()

Description copied from interface: SocialCollectionComponent

Get total size of the collection.

Specified by:

getTotalSize in interface SocialCollectionComponent

Returns:

the size of the collection.

setPagination

public void setPagination(CollectionPagination pagination)

Description copied from interface: SocialCollectionComponent

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

Specified by:

setPagination in interface SocialCollectionComponent

Parameters:

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

setSortedOrder

public void setSortedOrder(CollectionSortedOrder sortedOrder)

Description copied from interface: SocialCollectionComponent

Set the collection sorted order.

Specified by:

setSortedOrder in interface SocialCollectionComponent

Parameters:

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

getItems

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

Description copied from interface: SocialCollectionComponent

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

Specified by:

getItems in interface SocialCollectionComponent

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.