1 /* 2 * Copyright (c) 2002-2014, Mairie de 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.digglike.business; 35 36 import fr.paris.lutece.portal.service.plugin.Plugin; 37 38 import java.util.List; 39 40 41 /** 42 * 43 * Interface IFormSubmitDAO 44 * 45 */ 46 public interface IDiggSubmitDAO 47 { 48 /** 49 * Insert a new record in the table. 50 * @param diggSubmit instance of the Digg Submit object to insert 51 * @param plugin the plugin 52 * @return the id of the new Digg 53 */ 54 int insert( DiggSubmit diggSubmit, Plugin plugin ); 55 56 /** 57 * Load the data of the diggSubmit from the table 58 * 59 * @param nIdFormSubmit The identifier of the formResponse 60 * @param plugin the plugin 61 * @return the instance of the diggSubmit 62 */ 63 DiggSubmit load( int nIdFormSubmit, Plugin plugin ); 64 65 /** 66 * Delete the digg submit whose identifier is specified in parameter 67 * 68 * @param nIdDiggSubmit The identifier of the digg submit 69 * @param plugin the plugin 70 */ 71 void delete( int nIdDiggSubmit, Plugin plugin ); 72 73 /** 74 * Update the the diggSubmit in the table 75 * 76 * @param diggSubmit instance of the diggSubmit object to update 77 * @param plugin the plugin 78 */ 79 void store( DiggSubmit diggSubmit, Plugin plugin ); 80 81 /** 82 * Load the data of all the diggSubmit who verify the filter and returns them in a list 83 * @param filter the filter 84 * @param plugin the plugin 85 * @return the list of diggSubmit 86 */ 87 List<DiggSubmit> selectListByFilter( SubmitFilter filter, Plugin plugin ); 88 89 /** 90 * Load the id of all the diggSubmit who verify the filter and returns them in a list 91 * @param filter the filter 92 * @param plugin the plugin 93 * @return the list of diggSubmit id 94 */ 95 List<Integer> selectIdListByFilter( SubmitFilter filter, Plugin plugin ); 96 97 /** 98 * 99 * 100 * return the number of all the diggSubmit who verify the filter 101 * @param filter the filter 102 * @param plugin the plugin 103 * @return the number of all the diggSubmit who verify the filter 104 */ 105 int selectCountByFilter( SubmitFilter filter, Plugin plugin ); 106 107 /** 108 * Modify the order of a diggsubmit 109 * @param nNewOrder The order number 110 * @param nId The diggsubmit identifier 111 * @param plugin The plugin 112 */ 113 void storeDiggSubmitOrder( int nNewOrder, int nId, Plugin plugin ); 114 115 /** 116 * Calculate the new max order in a list 117 * @param nIdDigg the id of the digg 118 * @return the max order of diggsubmit 119 * @param plugin The plugin 120 */ 121 int maxOrderDiggSubmit( int nIdDigg, boolean bListPinned, Plugin plugin ); 122 }