View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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  /**
42   * Interface for Category DAO
43   */
44  public interface ICategoryDAO
45  {
46      /**
47       * Load the list of category
48       * @return The Collection of category
49       */
50      Collection<Category> selectAll(  );
51  
52      /**
53       * insert a new Category
54       * @param category the new Category object
55       */
56      void insert( Category category );
57  
58      /**
59       * Load the data of Category from the table
60       * @param nIdCategory The id of the category
61       * @return The Instance of the object Category
62       */
63      Category load( int nIdCategory );
64  
65      /**
66       * Load the data of Category from the table
67       * @param strCategoryName The name of the category
68       * @return The Collection of Category
69       */
70      Collection<Category> selectByName( String strCategoryName );
71  
72      /**
73       * Delete a record from the table
74       * @param nIdCategory The identifier of the object Category
75       */
76      void delete( int nIdCategory );
77  
78      /**
79       * Update the record in the table
80       * @param category The instance of the Category to update
81       */
82      void store( Category category );
83  
84      /**
85       * Return the number of documents linked to a category
86       * @param nIdCategory The category id
87       * @return count of id document
88       */
89      int selectCountIdDocuments( int nIdCategory );
90  
91      /**
92      * Return the image resource corresponding to the category id
93      * @param nCategoryId The Category id
94      * @return The image resource
95      */
96      ImageResource loadImageResource( int nCategoryId );
97  }