1 /* 2 * Copyright (c) 2002-2023, 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 35 package fr.paris.lutece.plugins.broadcastproxy.business; 36 37 import fr.paris.lutece.portal.service.plugin.Plugin; 38 import fr.paris.lutece.util.ReferenceList; 39 import java.util.List; 40 import java.util.Optional; 41 42 /** 43 * ISubscriptionLinkDAO Interface 44 */ 45 public interface ISubscriptionLinkDAO 46 { 47 /** 48 * Insert a new record in the table. 49 * @param subscriptionLink instance of the SubscriptionLink object to insert 50 * @param plugin the Plugin 51 */ 52 void insert( SubscriptionLink subscriptionLink, Plugin plugin ); 53 54 /** 55 * Update the record in the table 56 * @param subscriptionLink the reference of the SubscriptionLink 57 * @param plugin the Plugin 58 */ 59 void store( SubscriptionLink subscriptionLink, Plugin plugin ); 60 61 /** 62 * Delete a record from the table 63 * @param nKey The identifier of the SubscriptionLink to delete 64 * @param plugin the Plugin 65 */ 66 void delete( int nKey, Plugin plugin ); 67 68 /////////////////////////////////////////////////////////////////////////// 69 // Finders 70 71 /** 72 * Load the data from the table 73 * @param nKey The identifier of the subscriptionLink 74 * @param plugin the Plugin 75 * @return The instance of the subscriptionLink 76 */ 77 Optional<SubscriptionLink> load( int nKey, Plugin plugin ); 78 79 /** 80 * Load the data from the table by subscription id 81 * @param nSubscriptionId 82 * @param plugin the Plugin 83 * @return The instance of the subscriptionLink 84 */ 85 Optional<SubscriptionLink> loadBySubscriptionId( int nSubscriptionId, Plugin plugin ); 86 87 /** 88 * Load the data of all the subscriptionLink objects and returns them as a list 89 * @param plugin the Plugin 90 * @return The list which contains the data of all the subscriptionLink objects 91 */ 92 List<SubscriptionLink> selectSubscriptionLinksList( Plugin plugin ); 93 94 /** 95 * Load the id of all the subscriptionLink objects and returns them as a list 96 * @param plugin the Plugin 97 * @return The list which contains the id of all the subscriptionLink objects 98 */ 99 List<Integer> selectIdSubscriptionLinksList( Plugin plugin ); 100 101 /** 102 * Load the data of all the subscriptionLink objects and returns them as a referenceList 103 * @param plugin the Plugin 104 * @return The referenceList which contains the data of all the subscriptionLink objects 105 */ 106 ReferenceList selectSubscriptionLinksReferenceList( Plugin plugin ); 107 108 /** 109 * Load the data of all the avant objects and returns them as a list 110 * @param plugin the Plugin 111 * @param listIds liste of ids 112 * @return The list which contains the data of all the avant objects 113 */ 114 List<SubscriptionLink> selectSubscriptionLinksListByIds( Plugin _plugin, List<Integer> listIds ); 115 116 /** 117 * Return true if exist disabled newsletter 118 * @param plugin 119 * @return Return true if exist disabled newsletter 120 */ 121 boolean existDisabledNewsletter ( Plugin plugin ); 122 }