com.adobe.cq.social.review.client.api

Class AbstractReviewCollection<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

java.lang.Object

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

com.adobe.cq.social.commons.comments.api.AbstractCommentCollection<R,C>

com.adobe.cq.social.review.client.api.AbstractReviewCollection<R,C>

All Implemented Interfaces:

CommentCollection<R,C>, ReviewCollectionSocialComponent<R,C>, SocialCollectionComponent, SocialComponent

public abstract class AbstractReviewCollection<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>
extends AbstractCommentCollection<R,C>
implements ReviewCollectionSocialComponent<R,C>

Field Summary

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
AbstractReviewCollection(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager listProviderManager) Construct a CommentCollection using the specified Resource which should be the root of the collection.
AbstractReviewCollection(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager listProviderManager, UgcSearch search)
AbstractReviewCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager listProviderManager)
AbstractReviewCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager listProviderManager, UgcSearch search) Construct a CommentCollection using the specified Resource which should be the root of the collection with specified pagination for the children listing.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getAllowedRatings()
java.util.Map<java.lang.String,ResponseValue>	getCurrentUserResponse()
java.lang.String	getName()
RatingSocialComponent	getOverallRating()
java.util.Map<java.lang.String,java.lang.String>	getRatingAverages()
java.util.Map<java.lang.String,RatingSocialComponent>	getRatings()
java.lang.Long	getTotalNumberOfResponses()
boolean	isCompositeRating() Return true if the review has composite ratings.
boolean	isIncludeHistogram() Return true if the review summary includes histogram.

Methods inherited from class com.adobe.cq.social.commons.comments.api.AbstractCommentCollection

getAsMap, getConfiguration, getCreated, getFriendlyUrl, getItems, getLastModified, getMayPost, getPageInfo, getTotalSize, isTaggingAllowed, setPagination, setSortedOrder, toJSONString

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollection

getConfiguration, getCreated, getLastModified, getMayPost, getPageInfo, isTaggingAllowed

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Constructor Detail

AbstractReviewCollection

public AbstractReviewCollection(Resource resource,
                                ClientUtilities clientUtils,
                                CommentSocialComponentListProviderManager listProviderManager)

Construct a CommentCollection using the specified Resource which should be the root of the collection.

Parameters:

resource - the resource where the CommentCollection is located

listProviderManager - the list provider manager

clientUtils - the clientUtilities instance

AbstractReviewCollection

public AbstractReviewCollection(Resource resource,
                                ClientUtilities clientUtils,
                                CommentSocialComponentListProviderManager listProviderManager,
                                UgcSearch search)

AbstractReviewCollection

public AbstractReviewCollection(Resource resource,
                                ClientUtilities clientUtils,
                                QueryRequestInfo queryInfo,
                                CommentSocialComponentListProviderManager listProviderManager)

AbstractReviewCollection

public AbstractReviewCollection(Resource resource,
                                ClientUtilities clientUtils,
                                QueryRequestInfo queryInfo,
                                CommentSocialComponentListProviderManager listProviderManager,
                                UgcSearch search)

Construct a CommentCollection using the specified Resource which should be the root of the collection with specified pagination for the children listing.

Parameters:

resource - the resource where the CommentCollection is located

clientUtils - the clientUtilities instance

queryInfo - the query parameters, if any

listProviderManager - the list provider manager

search - the ugc search service

Method Detail

getOverallRating

public RatingSocialComponent getOverallRating()

Specified by:

getOverallRating in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

a RatingSocialComponent for overall rating.

getName

public java.lang.String getName()

Specified by:

getName in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

The name of the review component.

getTotalNumberOfResponses

public java.lang.Long getTotalNumberOfResponses()

Specified by:

getTotalNumberOfResponses in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

the total number of responses to this review.

getCurrentUserResponse

public java.util.Map<java.lang.String,ResponseValue> getCurrentUserResponse()
                                                                     throws TallyException,
                                                                            RepositoryException

Specified by:

getCurrentUserResponse in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

a map of the current users response given a session.

Throws:

TallyException - if there was an error retrieving the current users response.

RepositoryException - if there was an error retrieving the current users response.

getRatings

public java.util.Map<java.lang.String,RatingSocialComponent> getRatings()

Specified by:

getRatings in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

a map of all rating titles to the RatingSocialComponent for this review.

getRatingAverages

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

Specified by:

getRatingAverages in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

a map of all rating titles to rating averages for this review.

getAllowedRatings

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getAllowedRatings()

Specified by:

getAllowedRatings in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

the list of allowed ratings' properties that are designed by the author.

isCompositeRating

public boolean isCompositeRating()

Description copied from interface: ReviewCollectionSocialComponent

Return true if the review has composite ratings.

Specified by:

isCompositeRating in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

true if the review has composite ratings.

isIncludeHistogram

public boolean isIncludeHistogram()

Description copied from interface: ReviewCollectionSocialComponent

Return true if the review summary includes histogram.

Specified by:

isIncludeHistogram in interface ReviewCollectionSocialComponent<R extends ReviewSocialComponent,C extends CommentCollectionConfiguration>

Returns:

true if the review summary includes histogram.