View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.appointment.business.user;
35  
36  import java.util.List;
37  
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  
40  /**
41   * User DAO Interface
42   * 
43   * @author Laurent Payen
44   *
45   */
46  public interface IUserDAO
47  {
48      /**
49       * Insert a new record in the table.
50       * 
51       * @param user
52       *            instance of the user object to insert
53       * @param plugin
54       *            the Plugin
55       */
56      void insert( User user, Plugin plugin );
57  
58      /**
59       * Update the record in the table
60       * 
61       * @param user
62       *            the reference of the user
63       * @param plugin
64       *            the Plugin
65       */
66      void update( User user, Plugin plugin );
67  
68      /**
69       * Delete a record from the table
70       * 
71       * @param nIdUser
72       *            int identifier of the user to delete
73       * @param plugin
74       *            the Plugin
75       */
76      void delete( int nIdUser, Plugin plugin );
77  
78      /**
79       * Load the data from the table
80       * 
81       * @param nIdUser
82       *            The identifier of the user
83       * @param plugin
84       *            the Plugin
85       * @return The instance of the user
86       */
87      User select( int nIdUser, Plugin plugin );
88  
89      /**
90       * Load the data from the table
91       * 
92       * @param strGuid
93       *            The identifier of the user
94       * @param plugin
95       *            the Plugin
96       * @return The instance of the user
97       */
98      User selectByGuid( String strGuid, Plugin plugin );
99  
100     /**
101      * Return the users by its email
102      * 
103      * @param strEmail
104      *            the email of the user
105      * @param plugin
106      *            the plugin
107      * @return The Users found
108      */
109     List<User> findByEmail( String strEmail, Plugin plugin );
110 
111     /**
112      * Return the user by its first name, last name and email
113      * 
114      * @param strFirstName
115      *            the first name of the user
116      * @param strLastName
117      *            the last name of the user
118      * @param strEmail
119      *            the email of the user
120      * @param plugin
121      *            the plugin
122      * @return the user found
123      */
124     User findByFirstNameLastNameAndEmail( String strFirstName, String strLastName, String strEmail, Plugin plugin );
125 }