com.adobe.cq.social.notifications.client.api

Class AbstractSocialNotificationCollection

java.lang.Object

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

com.adobe.cq.social.notifications.client.api.AbstractSocialNotificationCollection

All Implemented Interfaces:

SocialNotificationCollection, SocialCollectionComponent, SocialComponent

public abstract class AbstractSocialNotificationCollection
extends BaseSocialComponent
implements SocialNotificationCollection

Field Summary

Fields inherited from interface com.adobe.cq.social.notifications.client.api.SocialNotificationCollection

ALL_CHANNEL_ID, DEFAULT_CHANNEL, DEFAULT_MAX_NOTIFICATIONS, PROP_CHANNEL_ID, PROP_MAX_NOTIFICATIONS, PROP_USER_ID, 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
AbstractSocialNotificationCollection(Resource resource, ClientUtilities clientUtils, NotificationManager notificationManager)
AbstractSocialNotificationCollection(Resource resource, ClientUtilities clientUtilities, QueryRequestInfo queryRequestInfo, NotificationManager notificationManager)
AbstractSocialNotificationCollection(Resource resource, ClientUtilities clientUtilities, QueryRequestInfo queryRequestInfo, NotificationManager notificationManager, java.lang.String userId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChannelId() Get the channel id of this collection
java.util.List<java.lang.Object>	getItems() Returns a list of children of this collection.
PageInfo	getPageInfo() Gets information about the pages for this collection.
static Constraint	getPathConstraint(Resource resource)
int	getTotalSize() Get total size of the collection.
long	getUnreadCount() Get the number of unread notifications
int	getUnreadCountConfigured()
java.lang.String	getUserId() Get the userId
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

AbstractSocialNotificationCollection

public AbstractSocialNotificationCollection(Resource resource,
                                            ClientUtilities clientUtils,
                                            NotificationManager notificationManager)

AbstractSocialNotificationCollection

public AbstractSocialNotificationCollection(Resource resource,
                                            ClientUtilities clientUtilities,
                                            QueryRequestInfo queryRequestInfo,
                                            NotificationManager notificationManager)

AbstractSocialNotificationCollection

public AbstractSocialNotificationCollection(Resource resource,
                                            ClientUtilities clientUtilities,
                                            QueryRequestInfo queryRequestInfo,
                                            NotificationManager notificationManager,
                                            java.lang.String userId)

Method Detail

getUnreadCount

public long getUnreadCount()

Description copied from interface: SocialNotificationCollection

Get the number of unread notifications

Specified by:

getUnreadCount in interface SocialNotificationCollection

Returns:

long unread count

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.

getChannelId

public java.lang.String getChannelId()

Description copied from interface: SocialNotificationCollection

Get the channel id of this collection

Specified by:

getChannelId in interface SocialNotificationCollection

Returns:

String channel ID

getUserId

public java.lang.String getUserId()

Description copied from interface: SocialNotificationCollection

Get the userId

Specified by:

getUserId in interface SocialNotificationCollection

Returns:

String user ID

getPageInfo

public PageInfo getPageInfo()

Description copied from interface: SocialNotificationCollection

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Specified by:

getPageInfo in interface SocialNotificationCollection

Returns:

information about the pagination system

getUnreadCountConfigured

public int getUnreadCountConfigured()

getPathConstraint

public static Constraint getPathConstraint(Resource resource)