com.adobe.cq.social.members.api.CommunityMemberUserProfile Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of uber-jar Show documentation
There is a newer version: 6.5.21
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2015 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.cq.social.members.api;

import java.util.List;
import java.util.Map;

import aQute.bnd.annotation.ProviderType;

import com.adobe.cq.social.scf.SocialAuthorizable;
import com.adobe.cq.social.scf.User;
import com.adobe.cq.social.user.api.UserProfile;
import com.adobe.cq.social.user.internal.UserProfileBadge;

@ProviderType
public interface CommunityMemberUserProfile extends UserProfile {
    String RESOURCE_TYPE = "social/members/components/hbs/userprofile";

    /**
     * @return Get the groups which user is member of.
     */
    SocialAuthorizable[] getMemberOfGroups();

    /**
     * Get the sites which user is member of.
     * @return List of Map with the following properties: name, siteId, siteUrlName, url, sitePagePath, creator,
     *         userRoles
     */
    List> getMemberOfSites();

    /**
     * Get the badges which assigned to the user.
     * @return List of badges witch assigned to the user.
     */
    List getAssignedBadges();

    /**
     * Get the earned badges which associated with the user.
     * @return List of earned badges which associated with the user.
     */
    List getEarnedBadges();

    /**
     * Get the top earned badges which assigned to the user.
     * @return List of top earned badges which associated with the user.
     */
    List getTopEarnedBadges();

    /**
     * @return true if the user is disabled, false otherwise
     */
    boolean getDisabled();

    /**
     * Checks if is users UGC Contributions has a limit
     * @return true, if users UGC contribution is limited
     */
    Boolean isUserUGCLimited();
}