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.crm.business.demand; 35 36 import fr.paris.lutece.portal.service.plugin.Plugin; 37 38 import java.util.List; 39 40 /** 41 * 42 * IDemandDAO 43 * 44 */ 45 public interface IDemandDAO 46 { 47 /** 48 * Generate a new primary key 49 * 50 * @param plugin 51 * the {@link Plugin} 52 * @return a new primary key 53 */ 54 int newPrimaryKey( Plugin plugin ); 55 56 /** 57 * Insert a new record in the table. 58 * 59 * @param demand 60 * instance 61 * @param plugin 62 * the Plugin 63 * @return the newly created demand id 64 */ 65 int insert( Demand demand, Plugin plugin ); 66 67 /** 68 * Update the record in the table 69 * 70 * @param demand 71 * the reference of the object 72 * @param plugin 73 * the Plugin 74 */ 75 void store( Demand demand, Plugin plugin ); 76 77 /** 78 * Delete a record from the table 79 * 80 * @param nIdDemand 81 * int identifier of the demand to delete 82 * @param plugin 83 * the Plugin 84 */ 85 void delete( int nIdDemand, Plugin plugin ); 86 87 /** 88 * Load the data from the table 89 * 90 * @param nIdDemand 91 * The identifier of the demand 92 * @param plugin 93 * the Plugin 94 * @return The instance of the object 95 */ 96 Demand load( int nIdDemand, Plugin plugin ); 97 98 /** 99 * Find all demands 100 * 101 * @param plugin 102 * {@link Plugin} 103 * @return a list of {@link Demand} 104 */ 105 List<Demand> selectAll( Plugin plugin ); 106 107 /** 108 * Find by filter 109 * 110 * @param dFilter 111 * the filter 112 * @param paginationProperties 113 * the pagination properties (can be null) 114 * @param plugin 115 * {@link Plugin} 116 * @return a list of {@link Demand} 117 */ 118 List<Demand> selectByFilter( DemandFilter dFilter, IPaginationProperties paginationProperties, Plugin plugin ); 119 120 /** 121 * Count results by filter 122 * 123 * @param dFilter 124 * the filter 125 * @param plugin 126 * {@link Plugin} 127 * @return the number of result 128 */ 129 int countByFilter( DemandFilter dFilter, Plugin plugin ); 130 131 /** 132 * Load demand by Remote Id and id demand 133 * 134 * @param strRemoteId 135 * the remote Id 136 * @param nIdDemandType 137 * the Id demand type 138 * @param plugin 139 * the plugin 140 * @return The instance of the object 141 */ 142 Demand loadByRemoteKey( String strRemoteId, int nIdDemandType, Plugin plugin ); 143 144 }