View Javadoc

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 IVoteTypeDAO
44   *
45   */
46  public interface ICategoryDAO
47  {
48      /**
49       * Insert a new record in the table.
50       *
51       * @param category instance of the Category object to insert
52       * @param plugin the plugin
53       */
54      void insert( Category category, Plugin plugin );
55  
56      /**
57       * update record in the table.
58       *
59       * @param category instance of the Category object to update
60       * @param plugin the plugin
61       */
62      void store( Category category, Plugin plugin );
63  
64      /**
65       * Delete a record from the table
66       *
67       * @param  nIdCategory The identifier of the category
68       * @param plugin the plugin
69       */
70      void delete( int nIdCategory, Plugin plugin );
71  
72      /**
73       * Load the data of the category from the table
74       *
75       * @param idKey The identifier of the category
76       * @param plugin the plugin
77       * @return The category
78       */
79      Category load( int idKey, Plugin plugin );
80  
81      /**
82       * Load the data of all category returns them in a  list
83       * @param plugin the plugin
84       * @return  the list of category
85       */
86      List<Category> select( Plugin plugin );
87  
88      /**
89       * Select all category associate to a digg and returns them in a  list
90       * @param plugin the plugin
91       * @return  the list of category
92       */
93      List<Category> select( int nIdDigg, Plugin plugin );
94  
95      /**
96      * true if there is a  digg associate to the category
97      * @param nIdCategory the key of the category
98      * @param plugin the plugin
99      * @return true if there is a digg associate to the category
100     */
101     boolean isAssociateToDigg( int nIdCategory, Plugin plugin );
102 
103     /**
104      * Delete an association between digg and categories
105      *
106      * @param nIdDigg The identifier of the digg
107      * @param nIdCategory The identifier of the category
108      * @param plugin the plugin
109      */
110     void deleteDiggAssociation( int nIdDigg, int nIdCategory, Plugin plugin );
111 
112     /**
113      * insert an association between  entry and a regular expression
114      *
115      * @param nIdDigg The identifier of the digg
116      * @param nIdCategory The identifier of the category
117      * @param plugin the plugin
118      */
119     void insertDiggAssociation( int nIdDigg, int nIdCategory, Plugin plugin );
120 }