com.adobe.cq.social.enablement.resource.model.api

Interface EnablementSocialModel

All Superinterfaces:

SocialComponent

public interface EnablementSocialModel
extends SocialComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENTS
static java.lang.String	RATINGS
static java.lang.String	RESOURCE_TYPE
static java.lang.String	SOCIAL

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
EnablementSocialCommentsModel	getComments()
EnablementSocialRatingsModel	getRatings()
EnablementSocialCommentsModel	updateSocialCommentsResource(java.lang.String displayName) Creates the enablement social comments resource endpoint.
EnablementSocialRatingsModel	updateSocialRatingsResource(java.lang.String displayName) Creates the enablement social ratings resource endpoint.

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

SOCIAL

static final java.lang.String SOCIAL

See Also:

Constant Field Values

COMMENTS

static final java.lang.String COMMENTS

See Also:

Constant Field Values

RATINGS

static final java.lang.String RATINGS

See Also:

Constant Field Values

Method Detail

getComments

EnablementSocialCommentsModel getComments()

Returns:

model representing enablement social comments resource

getRatings

EnablementSocialRatingsModel getRatings()

Returns:

model representing enablement social ratings resource

updateSocialRatingsResource

EnablementSocialRatingsModel updateSocialRatingsResource(java.lang.String displayName)
                                                  throws PersistenceException,
                                                         com.adobe.cq.social.enablement.exceptions.EnablementException

Creates the enablement social ratings resource endpoint.

Parameters:

displayName - - name of resource

Returns:

enablement social rating model

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs in enablement model

updateSocialCommentsResource

EnablementSocialCommentsModel updateSocialCommentsResource(java.lang.String displayName)
                                                    throws PersistenceException,
                                                           com.adobe.cq.social.enablement.exceptions.EnablementException

Creates the enablement social comments resource endpoint.

Parameters:

displayName - - name of resource

Returns:

enablement social comment model

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs in enablement model