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 package fr.paris.lutece.plugins.document.business.category; 35 36 import fr.paris.lutece.portal.service.image.ImageResource; 37 38 import java.util.Collection; 39 40 /** 41 * Interface for Category DAO 42 */ 43 public interface ICategoryDAO 44 { 45 /** 46 * Load the list of category 47 * 48 * @return The Collection of category 49 */ 50 Collection<Category> selectAll( ); 51 52 /** 53 * insert a new Category 54 * 55 * @param category 56 * the new Category object 57 */ 58 void insert( Category category ); 59 60 /** 61 * Load the data of Category from the table 62 * 63 * @param nIdCategory 64 * The id of the category 65 * @return The Instance of the object Category 66 */ 67 Category load( int nIdCategory ); 68 69 /** 70 * Load the data of Category from the table 71 * 72 * @param strCategoryName 73 * The name of the category 74 * @return The Collection of Category 75 */ 76 Collection<Category> selectByName( String strCategoryName ); 77 78 /** 79 * Delete a record from the table 80 * 81 * @param nIdCategory 82 * The identifier of the object Category 83 */ 84 void delete( int nIdCategory ); 85 86 /** 87 * Update the record in the table 88 * 89 * @param category 90 * The instance of the Category to update 91 */ 92 void store( Category category ); 93 94 /** 95 * Return the number of documents linked to a category 96 * 97 * @param nIdCategory 98 * The category id 99 * @return count of id document 100 */ 101 int selectCountIdDocuments( int nIdCategory ); 102 103 /** 104 * Return the image resource corresponding to the category id 105 * 106 * @param nCategoryId 107 * The Category id 108 * @return The image resource 109 */ 110 ImageResource loadImageResource( int nCategoryId ); 111 }