com.adobe.cq.social.badging.api

Interface BadgingService

public interface BadgingService

Badging service exposes operations like getBadges needed by components.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_BADGES Assigned and earned, including non-top badges.
static java.lang.String	ALL_TOP_BADGES Assigned and top earned badges only.
static java.lang.String	ALLOW_BADGES_PROP For components supporting badge display, use this Boolean property to toggle badge display on/off.
static java.lang.String	ASSIGNED_BADGES Assigned badges only.
static java.lang.String	ASSIGNED_PROP True if this is an assigned badge.
static java.lang.String	BADGE_EARNED_DATE_PROP The date when badge was awarded.
static java.lang.String	BADGE_EARNED_SCORE_PROP The score when badge was awarded.
static java.lang.String	BADGE_PATH_PROP Path of the badge's resource/image.
static java.lang.String	BADGE_PATHS_PROP advanced badging engine specific properties
static java.lang.String	BADGING_FOLDER_NAME badging folder name located in SRP after the home users profile dir.
static java.lang.String	BADGING_LEVELS_PROP
static java.lang.String	BADGING_RULES_PROP badging rule property.
static java.lang.String	BADGING_TYPE_PROP badging engine type.
static java.lang.String	EARNED_BADGES Earned badges only.
static java.lang.String	EARNED_TOP_BADGES Top earned badges only.
static java.lang.String	FILTER_BY_COMP_PROP When badge display is turned on in a component, set this boolean property in the component resource to display all the user's badges or just badges earned/assigned for this component.
static java.lang.String	RESOURCE_TYPE_BADGE A badge resource type
static java.lang.String	RULE_PAGE_PATH_PROP The containing page path of the rule's location this badge belongs to.
static java.lang.String	RULE_PROP The rule path.
static java.lang.String	SITE_ID_PROP The site the badge belongs to.
static java.lang.String	THRESHOLDS_PROP basic badging engine specific properties.
static java.lang.String	THRESHOLDS_SEPARATOR

Method Summary

Modifier and Type	Method and Description
int	deleteBadge(ResourceResolver resolver, java.lang.String userId, Resource ruleResource, Resource componentResource, java.lang.String badgeContentPath, boolean assigned) Delete a user's badges where the badgeContentPath matches the input parameter.
java.util.List<UserBadge>	getBadges(ResourceResolver resourceResolver, java.lang.String userId, Resource pageResource, CommunityContext context, java.lang.String badgeType) Retrieves badges for a user.
java.lang.String	getTopBadgeResourcePath(ResourceResolver resolver, java.lang.String userId, Resource ruleResource, Resource componentResource) Calculate and return the path of a user's top badge resource given a badging rule resource and a component resource.
void	saveBadge(ResourceResolver resolver, java.lang.String userId, Resource ruleResource, Resource componentResource, java.lang.String badgeContentPath, boolean assigned, java.util.Map<java.lang.String,java.lang.Object> props) Save or update a user's badge.

Field Detail

RESOURCE_TYPE_BADGE

static final java.lang.String RESOURCE_TYPE_BADGE

A badge resource type

See Also:

Constant Field Values

BADGING_TYPE_PROP

static final java.lang.String BADGING_TYPE_PROP

badging engine type.

See Also:

Constant Field Values

BADGING_RULES_PROP

static final java.lang.String BADGING_RULES_PROP

badging rule property.

See Also:

Constant Field Values

BADGING_FOLDER_NAME

static final java.lang.String BADGING_FOLDER_NAME

badging folder name located in SRP after the home users profile dir.

See Also:

Constant Field Values

RULE_PAGE_PATH_PROP

static final java.lang.String RULE_PAGE_PATH_PROP

The containing page path of the rule's location this badge belongs to.

See Also:

Constant Field Values

BADGE_PATH_PROP

static final java.lang.String BADGE_PATH_PROP

Path of the badge's resource/image.

See Also:

Constant Field Values

SITE_ID_PROP

static final java.lang.String SITE_ID_PROP

The site the badge belongs to.

See Also:

Constant Field Values

RULE_PROP

static final java.lang.String RULE_PROP

The rule path.

See Also:

Constant Field Values

ASSIGNED_PROP

static final java.lang.String ASSIGNED_PROP

True if this is an assigned badge.

See Also:

Constant Field Values

BADGE_EARNED_SCORE_PROP

static final java.lang.String BADGE_EARNED_SCORE_PROP

The score when badge was awarded.

See Also:

Constant Field Values

BADGE_EARNED_DATE_PROP

static final java.lang.String BADGE_EARNED_DATE_PROP

The date when badge was awarded.

See Also:

Constant Field Values

ALL_BADGES

static final java.lang.String ALL_BADGES

Assigned and earned, including non-top badges. For example, return a bronze badge even though current badge is silver.

See Also:

Constant Field Values

ALL_TOP_BADGES

static final java.lang.String ALL_TOP_BADGES

Assigned and top earned badges only.

See Also:

Constant Field Values

ASSIGNED_BADGES

static final java.lang.String ASSIGNED_BADGES

Assigned badges only.

See Also:

Constant Field Values

EARNED_BADGES

static final java.lang.String EARNED_BADGES

Earned badges only.

See Also:

Constant Field Values

EARNED_TOP_BADGES

static final java.lang.String EARNED_TOP_BADGES

Top earned badges only.

See Also:

Constant Field Values

THRESHOLDS_PROP

static final java.lang.String THRESHOLDS_PROP

basic badging engine specific properties.

See Also:

Constant Field Values

THRESHOLDS_SEPARATOR

static final java.lang.String THRESHOLDS_SEPARATOR

See Also:

Constant Field Values

BADGE_PATHS_PROP

static final java.lang.String BADGE_PATHS_PROP

advanced badging engine specific properties

See Also:

Constant Field Values

BADGING_LEVELS_PROP

static final java.lang.String BADGING_LEVELS_PROP

See Also:

Constant Field Values

ALLOW_BADGES_PROP

static final java.lang.String ALLOW_BADGES_PROP

For components supporting badge display, use this Boolean property to toggle badge display on/off.

See Also:

Constant Field Values

FILTER_BY_COMP_PROP

static final java.lang.String FILTER_BY_COMP_PROP

When badge display is turned on in a component, set this boolean property in the component resource to display all the user's badges or just badges earned/assigned for this component. The default is set to false so set this to true to display badges earned at this component or any components above this component.

See Also:

Constant Field Values

Method Detail

getBadges

java.util.List<UserBadge> getBadges(@Nonnull
                                    ResourceResolver resourceResolver,
                                    @Nonnull
                                    java.lang.String userId,
                                    Resource pageResource,
                                    CommunityContext context,
                                    java.lang.String badgeType)
                             throws RepositoryException

Retrieves badges for a user.

Parameters:

resourceResolver - resolver used for reading badge resources

userId - the user's userid

pageResource - restrict badges that are in this resource (and above) only. null for no path restrictions. Note that a resource in a community restricts badges to that community so no need to set the context parameter.

context - restrict badges to this community. null for no community restrictions. Useful for retrieving all badges for a specific community by setting pageResource to null.

badgeType - the badge type to retrieve: ALL, ASSIGNED, EARNED

Returns:

list of UserBadge objects for the user.

Throws:

RepositoryException - thrown if unable to retrieve the score

saveBadge

void saveBadge(@Nonnull
               ResourceResolver resolver,
               @Nonnull
               java.lang.String userId,
               Resource ruleResource,
               Resource componentResource,
               @Nonnull
               java.lang.String badgeContentPath,
               @Nonnull
               boolean assigned,
               java.util.Map<java.lang.String,java.lang.Object> props)
        throws RepositoryException,
               PersistenceException

Save or update a user's badge.

Parameters:

resolver - resolver used for writing the badge

userId - the user's userid

ruleResource - the badging rule the badge was earned from. Can't be null for earned badges.

componentResource - the resource where the rule was located (Not necessarily at a component. Could be at jcr:content, etc.). Can't be null for earned badges.

badgeContentPath - the path for the badge content resource containing the image

assigned - true if this badge is an assigned badge, false for an earned badge

props - any addition properties to store with the badge

Throws:

RepositoryException - error saving badge

PersistenceException - error saving badge

deleteBadge

int deleteBadge(@Nonnull
                ResourceResolver resolver,
                @Nonnull
                java.lang.String userId,
                Resource ruleResource,
                Resource componentResource,
                @Nonnull
                java.lang.String badgeContentPath,
                boolean assigned)
         throws RepositoryException,
                PersistenceException

Delete a user's badges where the badgeContentPath matches the input parameter.

Parameters:

resolver - resolver used for writing the badge

userId - the user's userid

ruleResource - the badging rule the badge was earned from. Can't be null for earned badges.

componentResource - the resource where the rule was located (Not necessarily at a component. Could be at jcr:content, etc.). Can't be null for earned badges.

badgeContentPath - the path for the badge content resource containing the image

assigned - true for only assigned badges

Returns:

number of badges deleted

Throws:

RepositoryException - error saving badge

PersistenceException - error saving badge

getTopBadgeResourcePath

java.lang.String getTopBadgeResourcePath(@Nonnull
                                         ResourceResolver resolver,
                                         @Nonnull
                                         java.lang.String userId,
                                         @Nonnull
                                         Resource ruleResource,
                                         @Nonnull
                                         Resource componentResource)
                                  throws RepositoryException

Calculate and return the path of a user's top badge resource given a badging rule resource and a component resource. Note that the resource at the calculate path might not exist, such as user has not earned a badge yet or the badging rule was not configured at that component.

Parameters:

resolver - resolver used for reading user generated content

userId - the userid of user

ruleResource - the badging rule resource

componentResource - the component resource (location of where scoring/badging rules were located)

Returns:

the path of the badge resource

Throws:

RepositoryException - thrown if unable to calculate resource path