NotificationHandler.java

/*
 *  Copyright (C) 2010-2012 Stichting Akvo (Akvo Foundation)
 *
 *  This file is part of Akvo FLOW.
 *
 *  Akvo FLOW is free software: you can redistribute it and modify it under the terms of
 *  the GNU Affero General Public License (AGPL) as published by the Free Software Foundation,
 *  either version 3 of the License or any later version.
 *
 *  Akvo FLOW 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 included below for more details.
 *
 *  The full license text can also be seen at <http://www.gnu.org/licenses/agpl.html>.
 */

package com.gallatinsystems.notification;

/**
 * class capable of sending a notification
 * 
 * @author Christopher Fagiani
 */
public interface NotificationHandler {

    /**
     * generates the notification content and delievers it to the recipients based on the
     * destOptions.
     * 
     * @param type
     * @param entityId
     * @param destinations
     * @param destOptions
     * @param serverBase
     */
    public void generateNotification(String type, Long entityId,
            String destinations, String destOptions, String serverBase);

}