com.adobe.cq.social.subscriptions.client.api

Class AbstractSubscriptionCollection

java.lang.Object

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

com.adobe.cq.social.subscriptions.client.api.AbstractSubscriptionCollection

All Implemented Interfaces:

SocialComponent, SubscriptionCollection

public class AbstractSubscriptionCollection
extends BaseSocialComponent
implements SubscriptionCollection

Base class of SCF SubscriptionCollection component. A subscription collection represents a relationships between a user and a resource or another user. The value of the userId and the followedId is obtained in the following order: If the request is a Post request, then the userId and the followedId are obtained from the request parameters. If the request is a Get request, then:

1. The userId is obtained from the resource Following.PROP_USERID property; If this property does not exist, the userId is obtained from the request's session user id.

2. The followedId is obtained from the resource Following.PROP_FOLLOWEDID property; If this property does not exist, the userId is obtained from the resource name

Field Summary

Fields inherited from interface com.adobe.cq.social.subscriptions.client.api.SubscriptionCollection

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
AbstractSubscriptionCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo q, java.util.List<Subscription> subscriptions) Construct a collection from the specified subscriptions
AbstractSubscriptionCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo q, SubscriptionManager subscriptionManager)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOwner() Get the owner of the subscription
java.lang.String	getPath() Get the path of this subscription
java.util.Map<java.lang.String,SubscriptionStatus>	getStates() Get the subscription status of this collection
java.lang.String	getSubscribedId() Get the id the user wants to subscribe to.
java.lang.String[]	getTypes() Get the list of subscription types
boolean	isSubscribed() Check if there is a selection in this collection
boolean	isUserLoggedIn() Check if there is a login session

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

AbstractSubscriptionCollection

public AbstractSubscriptionCollection(Resource resource,
                                      ClientUtilities clientUtils,
                                      QueryRequestInfo q,
                                      SubscriptionManager subscriptionManager)

AbstractSubscriptionCollection

public AbstractSubscriptionCollection(Resource resource,
                                      ClientUtilities clientUtils,
                                      QueryRequestInfo q,
                                      java.util.List<Subscription> subscriptions)

Construct a collection from the specified subscriptions

Parameters:

resource - Resource

clientUtils - ClientUtilities

q - QueryRequestInfo

subscriptions - List

Method Detail

getSubscribedId

public java.lang.String getSubscribedId()

Description copied from interface: SubscriptionCollection

Get the id the user wants to subscribe to. The id can be a resource path, or a user id.

Specified by:

getSubscribedId in interface SubscriptionCollection

Returns:

the subscribed id

getOwner

public java.lang.String getOwner()

Description copied from interface: SubscriptionCollection

Get the owner of the subscription

Specified by:

getOwner in interface SubscriptionCollection

Returns:

String

getPath

public java.lang.String getPath()

Description copied from interface: SubscriptionCollection

Get the path of this subscription

Specified by:

getPath in interface SubscriptionCollection

Returns:

String

getTypes

public java.lang.String[] getTypes()

Description copied from interface: SubscriptionCollection

Get the list of subscription types

Specified by:

getTypes in interface SubscriptionCollection

Returns:

String[]

getStates

public java.util.Map<java.lang.String,SubscriptionStatus> getStates()

Description copied from interface: SubscriptionCollection

Get the subscription status of this collection

Specified by:

getStates in interface SubscriptionCollection

Returns:

Map

isSubscribed

public boolean isSubscribed()

Description copied from interface: SubscriptionCollection

Check if there is a selection in this collection

Specified by:

isSubscribed in interface SubscriptionCollection

Returns:

boolean

isUserLoggedIn

public boolean isUserLoggedIn()

Description copied from interface: SubscriptionCollection

Check if there is a login session

Specified by:

isUserLoggedIn in interface SubscriptionCollection

Returns:

boolean