org.alfresco.rest.api.impl.node.ratings

Class AbstractRatingScheme

java.lang.Object

org.alfresco.rest.api.impl.node.ratings.AbstractRatingScheme

All Implemented Interfaces:

RatingScheme, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

FiveStarRatingScheme, LikesRatingScheme

public abstract class AbstractRatingScheme
extends Object
implements RatingScheme, org.springframework.beans.factory.InitializingBean

Manages the mapping between the rest api's representation of a node rating and the repository's representation of a node rating.

Author:

steveglover

Field Summary

Fields

Modifier and Type	Field and Description
protected ActivityService	activityService
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService
protected org.alfresco.util.registry.NamedObjectRegistry<RatingScheme>	nodeRatingSchemeRegistry
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected String	ratingSchemeId
protected String	ratingSchemeName
protected RatingService	ratingService
protected SiteService	siteService

Constructor Summary

Constructors

Constructor and Description
AbstractRatingScheme(String ratingSchemeId, String ratingSchemeName)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected abstract Object	getApiRating(Float rating)
protected abstract DocumentRatingSummary	getDocumentRatingSummary(org.alfresco.service.cmr.repository.NodeRef nodeRef)
NodeRating	getNodeRating(org.alfresco.service.cmr.repository.NodeRef nodeRef)
String	getRatingSchemeId()
String	getRatingServiceName()
protected RatingScheme	getRepoRatingScheme()
protected void	postActivity(org.alfresco.service.cmr.repository.NodeRef nodeRef, String activityType)
void	setActivityService(ActivityService activityService)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setNodeRatingSchemeRegistry(org.alfresco.util.registry.NamedObjectRegistry<RatingScheme> nodeRatingSchemeRegistry)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setRatingService(RatingService ratingService)
void	setSiteService(SiteService siteService)
void	validateRating(Float rating)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.rest.api.impl.node.ratings.RatingScheme

applyRating, removeRating

Field Detail

ratingSchemeName

protected String ratingSchemeName

ratingSchemeId

protected String ratingSchemeId

ratingService

protected RatingService ratingService

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

dictionaryService

protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

activityService

protected ActivityService activityService

siteService

protected SiteService siteService

nodeRatingSchemeRegistry

protected org.alfresco.util.registry.NamedObjectRegistry<RatingScheme> nodeRatingSchemeRegistry

Constructor Detail

AbstractRatingScheme

public AbstractRatingScheme(String ratingSchemeId,
                            String ratingSchemeName)

Method Detail

getRatingSchemeId

public String getRatingSchemeId()

getRatingServiceName

public String getRatingServiceName()

setNodeRatingSchemeRegistry

public void setNodeRatingSchemeRegistry(org.alfresco.util.registry.NamedObjectRegistry<RatingScheme> nodeRatingSchemeRegistry)

setActivityService

public void setActivityService(ActivityService activityService)

setSiteService

public void setSiteService(SiteService siteService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setRatingService

public void setRatingService(RatingService ratingService)

getRepoRatingScheme

protected RatingScheme getRepoRatingScheme()

getDocumentRatingSummary

protected abstract DocumentRatingSummary getDocumentRatingSummary(org.alfresco.service.cmr.repository.NodeRef nodeRef)

getApiRating

protected abstract Object getApiRating(Float rating)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

validateRating

public void validateRating(Float rating)

getNodeRating

public NodeRating getNodeRating(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Specified by:

getNodeRating in interface RatingScheme

postActivity

protected void postActivity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                            String activityType)