001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id$
018 */
019
020package org.nuxeo.ecm.platform.notification.api;
021
022import java.io.Serializable;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026public interface Notification extends Serializable {
027
028    String EMAIL_NOTIFICATION = "email";
029
030    /**
031     * @return the name.
032     */
033    String getName();
034
035    /**
036     * @return the channel.
037     */
038    String getChannel();
039
040    /**
041     * @return the template.
042     */
043    String getTemplate();
044
045    /**
046     * @return the autoSubscribed.
047     */
048    boolean getAutoSubscribed();
049
050    /**
051     * @return the subject.
052     */
053    String getSubject();
054
055    /**
056     * @return the subject template.
057     */
058    String getSubjectTemplate();
059
060    /**
061     * @return the availableIn.
062     */
063    String getAvailableIn();
064
065    String getLabel();
066
067    boolean getEnabled();
068
069    /**
070     * @return the mvelExpr used to evaluate the mail template name
071     * @since 5.6
072     */
073    String getTemplateExpr();
074
075}