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.crm.business.user;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Map;
39
40 /**
41 *
42 * ICRMUserAttributeDAO
43 *
44 */
45 public interface ICRMUserAttributeDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param nIdCRMUser
51 * the id crm user
52 * @param strUserAttributeKey
53 * user attribute key
54 * @param strUserAttributeValue
55 * user attribute value
56 * @param plugin
57 * the Plugin
58 */
59 void insert( int nIdCRMUser, String strUserAttributeKey, String strUserAttributeValue, Plugin plugin );
60
61 /**
62 * Delete a record from the table
63 *
64 * @param nIdCRMUser
65 * int identifier of the CRMUser to delete
66 * @param plugin
67 * the Plugin
68 */
69 void delete( int nIdCRMUser, Plugin plugin );
70
71 /**
72 * Load the data from the table
73 *
74 * @param nIdCRMUser
75 * The identifier of the CRMUser
76 * @param plugin
77 * the Plugin
78 * @return The instance of the CRMUser
79 */
80 Map<String, String> load( int nIdCRMUser, Plugin plugin );
81
82 /**
83 * Count the number of instance of a given value of an attribute
84 *
85 * @param strUserAttributeValue
86 * The value of the attribute
87 * @param strUserAttributeKey
88 * The key of the attribute
89 * @param plugin
90 * The plugin
91 * @return The number of instances of attributes with the given value for the given attribute key.
92 */
93 int countAttributeValueInstances( String strUserAttributeValue, String strUserAttributeKey, Plugin plugin );
94 }