com.adobe.cq.social.scf

Interface SocialComponentFactory

All Known Subinterfaces:

SocialCollectionComponentFactory, SocialNotificationComponentFactory, SubscriptionCollectionComponentFactory, UserSubscriptionPreferencesFactory

All Known Implementing Classes:

AbstractSocialComponentFactory, CommentSocialComponentFactory, CommentSystemSocialComponentFactory, CommunityGroupUserSocialComponentFactory, FilterGroupSocialComponentFactory, ForumSocialComponentFactory, JournalCommentSocialComponentFactory, JournalEntrySocialComponentFactory, JournalSidebarSocialComponentFactory, JournalSocialComponentFactory, ModerationDashboardSocialComponentFactory, PostSocialComponentFactory, QnaPostSocialComponentFactory, QnaRelatedComponentFactory, QnaTopicSocialComponentFactory, RatingSocialComponentFactory, ReviewCollectionSocialComponentFactory, ReviewSocialComponentFactory, TagCloudCollectionSocialComponentFactory, TallyResponseSocialComponentFactory, TallySocialComponentFactory, TopicSocialComponentFactory, VotingSocialComponentFactory

public interface SocialComponentFactory

A factory that will create instances of SocialComponent given a Resource.

Method Summary

Modifier and Type	Method and Description
int	getPriority() This determines the priority of this factory with respect to other factories that support the same resource types as this factory.
SocialComponent	getSocialComponent(Resource resource)
SocialComponent	getSocialComponent(Resource resource, ClientUtilities clientUtils, QueryRequestInfo requestInfo)
SocialComponent	getSocialComponent(Resource resource, SlingHttpServletRequest request)
java.lang.String	getSupportedResourceType()

Method Detail

getSocialComponent

SocialComponent getSocialComponent(Resource resource)

Parameters:

resource - the resource for which a SocialComponent is requested for.

Returns:

an implementation of SocialComponent for the given resource.

getSocialComponent

SocialComponent getSocialComponent(Resource resource,
                                   SlingHttpServletRequest request)

Parameters:

resource - the resource for which a SocialComponent is requested for.

request - the HTTP request for which this SocialComponent is being instantiated for.

Returns:

an implementation of SocialComponent for the given resource.

getSocialComponent

SocialComponent getSocialComponent(Resource resource,
                                   ClientUtilities clientUtils,
                                   QueryRequestInfo requestInfo)

Parameters:

resource - the resource for which a SocialComponent is requested for.

request - The <@link ClientUtilities> instance that associates with the current HTTP request.

requestInfo - the pagination applicable to the resoure children list.

Returns:

an implementation of SocialComponent for the given resource.

See Also:

AbstractSocialComponentFactory#getClientUtilities(SlingHttpServletRequest)

getPriority

int getPriority()

This determines the priority of this factory with respect to other factories that support the same resource types as this factory. Use a higher number to override default factories.

Returns:

an integer that reprenses the priority of this factory.

getSupportedResourceType

java.lang.String getSupportedResourceType()

Returns:

the resource type string that determines which resources this factory can created SocialComponents for.