1 /* 2 * Copyright (c) 2002-2021, City of Paris 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice 10 * and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice 13 * and the following disclaimer in the documentation and/or other materials 14 * provided with the distribution. 15 * 16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 * License 1.0 33 */ 34 package fr.paris.lutece.plugins.newsletter.business; 35 36 import fr.paris.lutece.portal.service.plugin.Plugin; 37 38 import java.util.ArrayList; 39 import java.util.List; 40 41 /** 42 * The skeleton data access methods for SendingNewsletter 43 * 44 */ 45 public interface ISendingNewsLetterDAO 46 { 47 /** 48 * Insert a new record in the table. 49 * 50 * @param sending 51 * the object to be inserted 52 * @param plugin 53 * the Plugin 54 */ 55 void insert( SendingNewsLetter sending, Plugin plugin ); 56 57 /** 58 * Delete the record in the database 59 * 60 * @param nSendingId 61 * the sending Identifier 62 * @param plugin 63 * the Plugin 64 */ 65 void delete( int nSendingId, Plugin plugin ); 66 67 /** 68 * Loads the data from the database 69 * 70 * @param nSendingId 71 * the sending identifier 72 * @param plugin 73 * the Plugin 74 * @return an object SendingNewsLetter 75 */ 76 SendingNewsLetter load( int nSendingId, Plugin plugin ); 77 78 /** 79 * Update the record in the table 80 * 81 * @param sending 82 * an instance of the class SendingNewsLetter 83 * @param plugin 84 * the Plugin 85 */ 86 void store( SendingNewsLetter sending, Plugin plugin ); 87 88 /** 89 * Returns the last sending performed for the newsletter of given id 90 * 91 * @param newsletterId 92 * the newsletter id for wich we need the last sending 93 * @param plugin 94 * the plugin 95 * @return the last sending for the given newsletter id - null if no sending found 96 */ 97 SendingNewsLetter selectLastSendingForNewsletterId( int newsletterId, Plugin plugin ); 98 99 /** 100 * Returns all the sendings in the database. 101 * 102 * @param plugin 103 * the plugin 104 * @return a list of SendingNewsLetter objects. 105 */ 106 List<SendingNewsLetter> findAllSendings( Plugin plugin ); 107 108 /** 109 * Returns the sendings corresponding to a list of ids. 110 * 111 * @return a list of SendingNewsLetter objects. 112 * @param listId 113 * A list of id corresponding to sent newsletters 114 * @param plugin 115 * the plugin 116 */ 117 ArrayList<SendingNewsLetter> findSendingsByIds( ArrayList<Integer> listId, Plugin plugin ); 118 119 /** 120 * Returns all the last sending performed for the newsletter of given id 121 * 122 * @param newsletterId 123 * the newsletter id for wich we need the last sending 124 * @param plugin 125 * the plugin 126 * @return the last sending for the given newsletter id - null if no sending found 127 */ 128 List<SendingNewsLetter> selectAllLastSendingForNewsletterId( int newsletterId, Plugin plugin ); 129 }