001/*
002 *  Copyright 2018 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.repository;
017
018import java.util.List;
019
020import org.ametys.core.user.UserIdentity;
021
022/**
023 * Interface to handle reactions on object
024 *
025 */
026public interface ReactionableObject
027{
028    
029    /** Reaction type. */
030    public enum ReactionType
031    {
032        /** Like */
033        LIKE
034    }
035    
036    /**
037     * Add the user reaction
038     * @param user the user
039     * @param reactionType the reaction type
040     */
041    public void addReaction(UserIdentity user, ReactionType reactionType);
042    
043    /**
044     * Remove the user reaction
045     * @param user the user
046     * @param reactionType the reaction type
047     */
048    public void removeReaction(UserIdentity user, ReactionType reactionType);
049    
050    /**
051     * Get the list of users who react
052     * @param reactionType the reaction type
053     * @return the list of users
054     */
055    public List<UserIdentity> getReactionUsers(ReactionType reactionType);
056    
057    
058}