com.adobe.cq.social.scf

Interface SocialComponent

All Known Subinterfaces:

Asset<T>, com.adobe.cq.social.site.api.BaseSite, Calendar, CalendarEvent, Comment<T>, CommentCollection<C,T>, CommunitiesContentFragment, CommunityAuthorizableCollection, CommunityGroup, CommunityGroupAuthor, CommunityGroupCollection, CommunityGroupFolder, CommunityGroupMemberListComponent, CommunityGroupUser, CommunityMemberGroup, CommunityMemberGroupCollection, CommunityMemberGroupMembers, CommunityMemberGroupProfile, CommunityMembersTunnelValidator, CommunityMemberUser, CommunityMemberUserCollection, CommunityMemberUserProfile, CommunitySimpleAuthorizableCollection, CommunityUser, ComposeMessageSocialComponent, Document, DVBarChart, DVDonutChart, DVLineChart, EditableCommunityGroup, EnablementAggregateResourceRatingReport, EnablementAggregateResourceReport, EnablementAssetModel, EnablementAssetsModel, EnablementAuthorizable, EnablementAuthorizableGroup, EnablementAuthorizables, EnablementAuthorizableUser, EnablementCardImage, EnablementCommunityGroup, EnablementCommunitySimpleUser, EnablementGroupCollection, EnablementLearningPathModel, EnablementLearningPathPrerequisite, EnablementLearningPathRatingReport, EnablementLearningPathResource, EnablementLearningPathResourceReport, EnablementLearningPathResources, EnablementLearningPathUserCompletionReport, EnablementLearningPathUserDetailReport, EnablementLearningPathUserEnrollmentReport, EnablementLearningPathView, EnablementLearningPathViewDetail, EnablementReportGroupEnrollmentList, EnablementReportUserEnrollmentList, EnablementResourceAggregateReportModel, EnablementResourceAssignmentStatus, EnablementResourceEnrollmentReport, EnablementResourceEnrollmentStatusReport, EnablementResourceModel, EnablementResourceModelList, EnablementResourceRatingsReport, EnablementResourceReport, EnablementResourceReportModel, EnablementResourceTrendReport, EnablementResourceUserReportModel, EnablementResourceVideoClientReport, EnablementResourceVideoDropoffReport, EnablementResourceVideoTracking, EnablementResourceView, EnablementResourceViewDetail, EnablementSite, EnablementSiteAssignmentsView, EnablementSiteCatalog, EnablementSiteCatalogView, EnablementSiteCollection, EnablementSocialCommentsModel, EnablementSocialComponent, EnablementSocialModel, EnablementSocialRatingsModel, FileLibrary<P,C>, FilterGroup, Following, Forum<P,C>, Journal, JournalEntryComment, JournalSidebar, LikingSocialComponent, MessageBoxSocialComponent<P,C>, MessageSocialComponent<T>, MessagingUser, ModerationDashboard, MutableFollowing, Post<T>, QnaPost, QnaPostCollection, RatingSocialComponent, RelationshipCollection, ReviewCollectionSocialComponent<C,T>, ReviewSocialComponent<C>, SearchComponent, SearchResultComponent, com.adobe.cq.social.activitystreams.client.api.SocialActivity, SocialAuthorizable, SocialCollectionComponent, SocialGroup, SocialNotification, SocialNotificationCollection, SubscriptionCollection, TagCloud, TagCloudTag, TallyResponseSocialComponent, TallySocialComponent, User, UserChooserComponent, UserDetails, com.adobe.cq.social.user.api.UserProfile, UserSubscriptionPreferences, VotingSocialComponent

All Known Implementing Classes:

AbstractAsset, AbstractComment, AbstractCommentCollection, com.adobe.cq.social.user.api.AbstractCommunityAuthorizableCollection, AbstractCommunityGroupMemberListComponent, AbstractCommunityGroupUser, AbstractDVBarChartComponent, AbstractDVDonutChartComponent, AbstractDVLineChartComponent, AbstractFileLibrary, AbstractFollowing, AbstractForum, AbstractLiking, AbstractPost, AbstractRating, AbstractRelationshipCollection, AbstractReview, AbstractReviewCollection, AbstractSocialNotificationCollection, AbstractSubscriptionCollection, AbstractTally, AbstractTallyResponse, AbstractUser, AbstractVoting, BaseSocialComponent

public interface SocialComponent

An easy to use, client friendly object that represent Social components.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSV_SELECTOR
static java.lang.String	DEFAULT_SELECTOR
static java.lang.String	INDEX_SELECTOR
static java.lang.String	PROP_REFERER Request parameter and header name for referrer Url.
static java.lang.String	QUERY_SELECTOR
static java.lang.String	TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAsMap()
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
ResourceID	getId()
SocialComponent	getParentComponent() Gets the immediate parent of this component.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Get the resource value for the specified key.
<T> T	getProperty(java.lang.String name, T defaultValue) Get the resource value for the specified key, if the property doesn't exist, return the specified default value.
Resource	getResource()
java.lang.String	getResourceType()
SocialComponent	getSourceComponent() Gets the SocialComponent that created this piece of UGC.
java.lang.String	getUrl()
java.lang.String	toJSONString(boolean tidy)

Field Detail

CSV_SELECTOR

static final java.lang.String CSV_SELECTOR

See Also:

Constant Field Values

DEFAULT_SELECTOR

static final java.lang.String DEFAULT_SELECTOR

See Also:

Constant Field Values

QUERY_SELECTOR

static final java.lang.String QUERY_SELECTOR

See Also:

Constant Field Values

INDEX_SELECTOR

static final java.lang.String INDEX_SELECTOR

See Also:

Constant Field Values

TRANSLATE_SELECTOR

static final java.lang.String TRANSLATE_SELECTOR

See Also:

Constant Field Values

PROP_REFERER

static final java.lang.String PROP_REFERER

Request parameter and header name for referrer Url.

See Also:

Constant Field Values

Method Detail

getId

ResourceID getId()

Returns:

the ResourceID of the resource.

getResourceType

java.lang.String getResourceType()

Returns:

the resource type of the resource.

getUrl

java.lang.String getUrl()

Returns:

the url to the resource if possible.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns:

a list of resource properties.

getProperty

<T> T getProperty(java.lang.String name,
                  java.lang.Class<T> type)

Get the resource value for the specified key.

Type Parameters:

T - type

Parameters:

name - name/key of the property

type - Class

Returns:

T property

getProperty

<T> T getProperty(java.lang.String name,
                  T defaultValue)

Get the resource value for the specified key, if the property doesn't exist, return the specified default value.

Type Parameters:

T - type

Parameters:

name - name/key of the property

defaultValue - type T

Returns:

T property

toJSONString

java.lang.String toJSONString(boolean tidy)
                       throws JsonException

Parameters:

tidy - true to return readable JSON string.

Returns:

JSON representation of this object.

Throws:

JsonException - if an error occurs during serialization.

getResource

Resource getResource()

Returns:

Resource - the resource represented by this SocialComponent.

getAsMap

java.util.Map<java.lang.String,java.lang.Object> getAsMap()

Returns:

Map this object represented as a map.

getParentComponent

SocialComponent getParentComponent()

Gets the immediate parent of this component.

Returns:

the parent social component or {code}null{/code} if none exists

getSourceComponent

SocialComponent getSourceComponent()

Gets the SocialComponent that created this piece of UGC. This generally links back to the component that is in the real content tree.

Returns:

the source social component

getFriendlyUrl

java.lang.String getFriendlyUrl()

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Returns:

friendlyURL String