IMailingList.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.contrib.mailarchive;

/**
 * A mailing-list.
 * 
 * @author jbousque
 */
public interface IMailingList
{
    /**
     * Display name of this mailing-list.
     * 
     * @return
     */
    public String getDisplayName();

    /**
     * Pattern (contains), ie part of an email address matched against email address fields, to decide if an email
     * belongs to this mailing-list or not.
     * 
     * @return An inclusion pattern.
     */
    public String getPattern();

    /**
     * A tag to be set on loaded emails and topics pages, when they belong to this mailing-list.
     * 
     * @return
     */
    public String getTag();

    /**
     * Optionally, a mailing-list can be part of a group of mailing-lists.
     * 
     * @return The group this list belongs to, or null if it doesn't belong to a group.
     */
    public IMailingListGroup getGroup();

}