View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.mylutece.business.attribute;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.List;
39  
40  /**
41   *
42   * IAttributeFieldDAO
43   *
44   */
45  public interface IAttributeFieldDAO
46  {
47      /**
48       * Load attribute field
49       * 
50       * @param nIdField
51       *            ID Field
52       * @param plugin
53       *            The plugin
54       * @return Attribute Field
55       */
56      AttributeField load( int nIdField, Plugin plugin );
57  
58      /**
59       * Select attribute by id field
60       * 
61       * @param nIdField
62       *            id field
63       * @param plugin
64       *            The plugin
65       * @return user attribute
66       */
67      IAttribute selectAttributeByIdField( int nIdField, Plugin plugin );
68  
69      /**
70       * Load the lists of attribute field associated to an attribute
71       * 
72       * @param nIdAttribute
73       *            the ID attribute
74       * @param plugin
75       *            The plugin
76       * @return the list of attribute fields
77       */
78      List<AttributeField> selectAttributeFieldsByIdAttribute( int nIdAttribute, Plugin plugin );
79  
80      /**
81       * Insert a new attribute field
82       * 
83       * @param attributeField
84       *            the attribute field
85       * @param plugin
86       *            The plugin
87       * @return new PK
88       */
89      int insert( AttributeField attributeField, Plugin plugin );
90  
91      /**
92       * Update an attribute field
93       * 
94       * @param attributeField
95       *            the attribute field
96       * @param plugin
97       *            The plugin
98       */
99      void store( AttributeField attributeField, Plugin plugin );
100 
101     /**
102      * Delete an attribute field
103      * 
104      * @param nIdField
105      *            the attribute field id
106      * @param plugin
107      *            The plugin
108      */
109     void delete( int nIdField, Plugin plugin );
110 
111     /**
112      * Delete all attribute field from an attribute id
113      * 
114      * @param nIdAttribute
115      *            the ID attribute
116      * @param plugin
117      *            The plugin
118      */
119     void deleteAttributeFieldsFromIdAttribute( int nIdAttribute, Plugin plugin );
120 }