001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.newsletter;
029
030/**
031 * Interface for recipients of {@link I_CmsNewsletter} objects.<p>
032 */
033public interface I_CmsNewsletterRecipient {
034
035    /**
036     * Returns the email address of the recipient.<p>
037     *
038     * @return the email address of the recipient.
039     */
040    String getEmail();
041
042    /**
043     * Returns the firstname of the recipient.<p>
044     *
045     * @return the firstname of the recipient.
046     */
047    String getFirstname();
048
049    /**
050     * Returns the nicename of the recipient.<p>
051     *
052     * @return the nicename of the recipient.
053     */
054    String getFullName();
055
056    /**
057     * Returns the lastname of the recipient.<p>
058     *
059     * @return the lastname of the recipient.
060     */
061    String getLastname();
062
063    /**
064     * Returns <code>true</code> in case this newsletter recipient has subscribed to the given content.<p>
065     *
066     * @param content the content to check for subscription
067     * @return <code>true</code> in case this newsletter recipient has subscribed to the given content
068     */
069    boolean isSubscriber(I_CmsNewsletterContent content);
070}