com.adobe.cq.social.scoring.api

Interface ScoringEngine

public interface ScoringEngine

Scoring engine interface.

Method Summary

Modifier and Type	Method and Description
void	applyRule(Resource scoreRule, Resource subRule, java.lang.String verb, java.lang.String topic, java.lang.String userId, Resource ugcResource, Resource componentResource) Calcuate score based on engine's algorithm.
java.lang.String	getScoringType() Get this scoring engine type.
void	unscoredData(java.lang.String ruleAction, Resource ugcResource) Process UGC for scoring even though no rule was defined.

Method Detail

applyRule

void applyRule(@Nonnull
               Resource scoreRule,
               @Nonnull
               Resource subRule,
               @Nonnull
               java.lang.String verb,
               @Nullable
               java.lang.String topic,
               @Nonnull
               java.lang.String userId,
               @Nonnull
               Resource ugcResource,
               @Nonnull
               Resource componentResource)

Calcuate score based on engine's algorithm.

Parameters:

scoreRule - scoringRule resource

subRule - The scoring sub rule resource

verb - The action verb from a SocialEvent

topic - The topic from a SocialEvent

userId - The user the score should apply to

ugcResource - The UGC resource used for the scoring calculation

componentResource - The component where the rule is located

getScoringType

@Nonnull
java.lang.String getScoringType()

Get this scoring engine type.

Returns:

the engine type

unscoredData

void unscoredData(@Nonnull
                  java.lang.String ruleAction,
                  @Nonnull
                  Resource ugcResource)

Process UGC for scoring even though no rule was defined.

Parameters:

ruleAction - The event's action verb

ugcResource - The UGC resource used for the scoring calculation