View Javadoc
1   /*
2    * Copyright (c) 2002-2017, 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.directory.business.attribute;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.Map;
39  
40  /**
41   *
42   * IDirectoryAttributeDAO
43   *
44   */
45  public interface IDirectoryAttributeDAO
46  {
47      /**
48       * Load the attributes of the directory
49       * 
50       * @param nIdDirectory
51       *            the id directory
52       * @param plugin
53       *            the plugin
54       * @return a map of key - value
55       */
56      Map<String, Object> load( int nIdDirectory, Plugin plugin );
57  
58      /**
59       * Create the attributes of the directory
60       * 
61       * @param nIdDirectory
62       *            the id directory
63       * @param strAttributeKey
64       *            the attribute key
65       * @param attributeValue
66       *            the attribute value
67       * @param plugin
68       *            the plugin
69       */
70      void insert( int nIdDirectory, String strAttributeKey, Object attributeValue, Plugin plugin );
71  
72      /**
73       * Remove the attributes of the directory
74       * 
75       * @param nIdDirectory
76       *            the id directory
77       * @param plugin
78       *            the plugin
79       */
80      void remove( int nIdDirectory, Plugin plugin );
81  }