View Javadoc
1   /*
2    * Copyright (c) 2002-2019, 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   
35  package fr.paris.lutece.plugins.atelieraba.business;
36  
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.util.ReferenceList;
39  import java.util.List;
40  
41  /**
42   * IAtelierDAO Interface
43   */
44  public interface IAtelierDAO
45  {
46      /**
47       * Insert a new record in the table.
48       * @param atelier instance of the Atelier object to insert
49       * @param plugin the Plugin
50       */
51      void insert( Atelier atelier, Plugin plugin );
52  
53      /**
54       * Update the record in the table
55       * @param atelier the reference of the Atelier
56       * @param plugin the Plugin
57       */
58      void store( Atelier atelier, Plugin plugin );
59  
60      /**
61       * Delete a record from the table
62       * @param nKey The identifier of the Atelier to delete
63       * @param plugin the Plugin
64       */
65      void delete( int nKey, Plugin plugin );
66  
67      ///////////////////////////////////////////////////////////////////////////
68      // Finders
69  
70      /**
71       * Load the data from the table
72       * @param nKey The identifier of the atelier
73       * @param plugin the Plugin
74       * @return The instance of the atelier
75       */
76      Atelier load( int nKey, Plugin plugin );
77  
78      /**
79       * Load the data of all the atelier objects and returns them as a list
80       * @param plugin the Plugin
81       * @return The list which contains the data of all the atelier objects
82       */
83      List<Atelier> selectAteliersList( Plugin plugin );
84      
85      /**
86       * Load the id of all the atelier objects and returns them as a list
87       * @param plugin the Plugin
88       * @return The list which contains the id of all the atelier objects
89       */
90      List<Integer> selectIdAteliersList( Plugin plugin );
91      
92      /**
93       * Load the data of all the atelier objects and returns them as a referenceList
94       * @param plugin the Plugin
95       * @return The referenceList which contains the data of all the atelier objects
96       */
97      ReferenceList selectAteliersReferenceList( Plugin plugin );
98  
99      /**
100      * Load the data from the table
101      * @param inscritId the inscritId
102      * @param numero the numero
103      * @param plugin the Plugin
104      * @return The instance of the atelier or null if no atelier
105      */
106 	Atelier loadByInscritNumero(int inscritId, int numero, Plugin plugin);
107 }