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

Class AbstractFollowing

java.lang.Object

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

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

All Implemented Interfaces:

Following, MutableFollowing, SocialComponent

public class AbstractFollowing
extends BaseSocialComponent
implements MutableFollowing

Base class of SCF Following component. A Following represents a relationship between two users. 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.graph.client.api.Following

PROP_FOLLOWEDID, PROP_USERID, 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
AbstractFollowing(Resource resource, ClientUtilities clientUtils, QueryRequestInfo q)

Method Summary

Modifier and Type	Method and Description
Edge	edge() Get the relationship representing this instance
Vertex	followedNode() Get the followed user graph node
java.lang.String	getFollowedId() Get the followed Id.
java.lang.String	getFollowedResourceType() Get the followed Resource Type
boolean	getIsFollowed() Check the follow state
boolean	getIsFollowedUser() Check if the followed item is a user
boolean	getMayFollow() Indicate whether the current user can follow the specify following user.
User	getUser() Get the user
void	setFollowingState(boolean newState) Toggle the state of the following instance.
SocialGraph	socialGraph() Get socialGraph of this instance.
Vertex	userNode() Get the user social graph node

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

AbstractFollowing

public AbstractFollowing(Resource resource,
                         ClientUtilities clientUtils,
                         QueryRequestInfo q)

Method Detail

getUser

public User getUser()

Description copied from interface: Following

Get the user

Specified by:

getUser in interface Following

Returns:

the follower

getIsFollowed

public boolean getIsFollowed()

Description copied from interface: Following

Check the follow state

Specified by:

getIsFollowed in interface Following

Returns:

the current following status

socialGraph

public SocialGraph socialGraph()

Description copied from interface: Following

Get socialGraph of this instance.

Specified by:

socialGraph in interface Following

Returns:

the social graph

edge

public Edge edge()

Description copied from interface: Following

Get the relationship representing this instance

Specified by:

edge in interface Following

Returns:

the edge of this instance

userNode

public Vertex userNode()

Description copied from interface: Following

Get the user social graph node

Specified by:

userNode in interface Following

Returns:

the vertex of this instance

followedNode

public Vertex followedNode()

Description copied from interface: Following

Get the followed user graph node

Specified by:

followedNode in interface Following

Returns:

the followed vertex node

getIsFollowedUser

public boolean getIsFollowedUser()

Description copied from interface: Following

Check if the followed item is a user

Specified by:

getIsFollowedUser in interface Following

Returns:

true if the followed user is a user

getMayFollow

public boolean getMayFollow()

Description copied from interface: Following

Indicate whether the current user can follow the specify following user.

Specified by:

getMayFollow in interface Following

Returns:

true if the followed component can be followed.

setFollowingState

public void setFollowingState(boolean newState)

Description copied from interface: MutableFollowing

Toggle the state of the following instance.

Specified by:

setFollowingState in interface MutableFollowing

Parameters:

newState - the new state of followwing

getFollowedId

public java.lang.String getFollowedId()

Description copied from interface: Following

Get the followed Id. This could be a CommunityUser or other SocialComponent.

Specified by:

getFollowedId in interface Following

Returns:

the followed component

getFollowedResourceType

public java.lang.String getFollowedResourceType()

Description copied from interface: Following

Get the followed Resource Type

Specified by:

getFollowedResourceType in interface Following

Returns: