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 java.util.List;
38  
39  import fr.paris.lutece.portal.service.plugin.Plugin;
40  import fr.paris.lutece.util.ReferenceList;
41  
42  /**
43   * IEleveArpegeDAO Interface
44   */
45  public interface IEleveArpegeDAO
46  {
47      /**
48       * Insert a new record in the table.
49       *
50       * @param eleveArpege
51       *            instance of the EleveArpege object to insert
52       * @param plugin
53       *            the Plugin
54       */
55      void insert( EleveArpege eleveArpege, Plugin plugin );
56  
57      /**
58       * Update the record in the table
59       *
60       * @param eleveArpege
61       *            the reference of the EleveArpege
62       * @param plugin
63       *            the Plugin
64       */
65      void store( EleveArpege eleveArpege, Plugin plugin );
66  
67      /**
68       * Delete a record from the table
69       *
70       * @param nKey
71       *            The identifier of the EleveArpege to delete
72       * @param plugin
73       *            the Plugin
74       */
75      void delete( int nKey, Plugin plugin );
76  
77      ///////////////////////////////////////////////////////////////////////////
78      // Finders
79  
80      /**
81       * Load the data from the table
82       *
83       * @param nKey
84       *            The identifier of the eleveArpege
85       * @param plugin
86       *            the Plugin
87       * @return The instance of the eleveArpege
88       */
89      EleveArpege load( int nKey, Plugin plugin );
90  
91      /**
92       * Load the data of all the eleveArpege objects and returns them as a list
93       *
94       * @param plugin
95       *            the Plugin
96       * @return The list which contains the data of all the eleveArpege objects
97       */
98      List<EleveArpege> selectEleveArpegesList( Plugin plugin );
99  
100     /**
101      * Load the id of all the eleveArpege objects and returns them as a list
102      *
103      * @param plugin
104      *            the Plugin
105      * @return The list which contains the id of all the eleveArpege objects
106      */
107     List<Integer> selectIdEleveArpegesList( Plugin plugin );
108 
109     /**
110      * Load the data of all the eleveArpege objects and returns them as a referenceList
111      *
112      * @param plugin
113      *            the Plugin
114      * @return The referenceList which contains the data of all the eleveArpege objects
115      */
116     ReferenceList selectEleveArpegesReferenceList( Plugin plugin );
117 
118     /**
119      * Load the data from the table
120      *
121      * @param nom
122      *            of the eleveArpege
123      * @param prenom
124      *            of the eleveArpege
125      * @param email
126      *            of the eleveArpege
127      * @param telephone
128      *            of the eleveArpege
129      * @return an instance of EleveArpege
130      */
131     EleveArpege selectByCode( String nom, String prenom, String mail, String telephone, Plugin plugin );
132 
133     /**
134      * Load the id of all the eleveArpege objects with the same given mail or the same give phone number
135      *
136      * @param mail
137      *            of the Candidat
138      * @param telephone
139      *            of the Candidat
140      * @return a List of the id of all the eleveArpege
141      */
142     List<Integer> selectEleveProbable( String email, String telephone, Plugin plugin );
143 }