/**
 * Copyright (C) 2017-2021 Christian Pierre MOMON <cmomon@april.org>
 * Copyright (C) 2011-2013 Nicolas Vinot <aeris@imirhil.fr>
 *
 * This file is part of (April) Hebdobot.
 *
 * Hebdobot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Hebdobot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Hebdobot.  If not, see <http://www.gnu.org/licenses/>
 */
package org.april.hebdobot.bot.review;

import fr.devinsy.strings.StringSet;

/**
 * The Class Topic.
 */
public abstract class Topic
{
    private final String title;

    /**
     * Instantiates a new topic.
     *
     * @param title
     *            the title
     */
    protected Topic(final String title)
    {
        this.title = title;
    }

    /**
     * Adds the.
     *
     * @param message
     *            the message
     */
    public abstract void add(Message message);

    /**
     * Cancel previous.
     *
     * @param participant
     *            the participant
     */
    public abstract String cancelPreviousMessage(final String participant);

    /**
     * Gets the participants.
     *
     * @return the participants
     */
    public abstract StringSet getParticipants();

    /**
     * Gets the title.
     *
     * @return the title
     */
    public String getTitle()
    {
        return this.title;
    }

    /**
     * Checks for message from.
     *
     * @param author
     *            the author
     * @return true, if successful
     */
    public abstract boolean hasMessage(String author);
}