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.mylutece.modules.wssodatabase.authentication.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40
41 /**
42 *
43 * @author ehelouaret
44 *
45 */
46 public interface IWssoProfilDAO
47 {
48 /**
49 * Insert a new record in the table.
50 *
51 * @param wssoProfil The wssoProfil object
52 * @param plugin The Plugin using this data access service
53 */
54 void insert( WssoProfil wssoProfil, Plugin plugin );
55
56 /**
57 * Load the data of WssoProfil from the table
58 *
59 * @param nWssoProfilCode The identifier of WssoProfil
60 * @param plugin The Plugin using this data access service
61 * @return the instance of the WssoProfil
62 */
63 WssoProfil load( String nWssoProfilCode, Plugin plugin );
64
65 /**
66 * Delete a record from the table
67 * @param wssoProfil The WssoProfil object
68 * @param plugin The Plugin using this data access service
69 */
70 void delete( WssoProfil wssoProfil, Plugin plugin );
71
72 /**
73 * Update the record in the table
74 * @param wssoProfil The reference of wssoProfil
75 * @param plugin The Plugin using this data access service
76 */
77 void store( WssoProfil wssoProfil, Plugin plugin );
78
79 /**
80 * Load the list of wssoProfils
81 * @param plugin The Plugin using this data access service
82 * @return The Collection of the WssoProfils
83 */
84 List<WssoProfil> selectWssoProfilList( Plugin plugin );
85
86 /**
87 * Load the list of wssoProfils for a role
88 * @param nIdRole The role of WssoProfil
89 * @param plugin The Plugin using this data access service
90 * @return The Collection of the WssoProfils
91 */
92
93 // Collection selectWssoProfilsListForRole( int nIdRole, Plugin plugin );
94
95 // WssoProfil findWssoProfilByCode( String strCode, Plugin plugin );
96
97 /**
98 * Find profil by code and description
99 *
100 * @param strCode the code
101 * @param strDescription the description
102 * @param plugin the current plugin
103 * @return the profil
104 */
105 WssoProfil findWssoProfilByCodeAndDescription( String strCode, String strDescription, Plugin plugin );
106
107 /**
108 * Find the profils by description
109 *
110 * @param strDescription the description
111 * @param plugin the current plugin
112 * @return the profil list for the description
113 */
114 List<WssoProfil> findWssoProfilsByDescription( String strDescription, Plugin plugin );
115
116 /**
117 *
118 * Find profils for a user
119 *
120 * @param nWssoUserId the user id
121 * @param plugin the current plugin
122 * @return the profils's list for a user
123 */
124 List<String> findWssoProfilsForUser( int nWssoUserId, Plugin plugin );
125
126 /**
127 * Check if the specified profil is assigned to a user
128 *
129 * @param strCode profil code
130 * @param plugin the current plugin
131 * @return true if the profil is assigned, else false
132 */
133 boolean checkProfilAssigned( String strCode, Plugin plugin );
134 }