View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.document.business.attributes;
35  
36  import fr.paris.lutece.util.ReferenceList;
37  
38  import java.util.Collection;
39  import java.util.List;
40  import java.util.Locale;
41  
42  
43  /**
44   * AttributeTypeDAO Interface
45   */
46  public interface IAttributeTypeDAO
47  {
48      /**
49       * Delete a record from the table
50       *
51       * @param documentAttributeType The DocumentAttributeType object
52       */
53      void delete( AttributeType documentAttributeType );
54  
55      /**
56       * Gets attributes managers list
57       *
58       * @return The list of attribute managers
59       */
60      ReferenceList getAttributeManagersList(  );
61  
62      /**
63       * Insert a new record in the table.
64       *
65       *
66       * @param documentAttributeType The documentAttributeType object
67       */
68      void insert( AttributeType documentAttributeType );
69  
70      /**
71       * Load the data of DocumentAttributeType from the table
72       *
73       *
74       * @param nDocumentAttributeTypeId The identifier of DocumentAttributeType
75       * @return the instance of the DocumentAttributeType
76       */
77      AttributeType load( int nDocumentAttributeTypeId );
78  
79      /**
80       * Load the list of Attribute Types
81       *
82       * @param locale
83       * @return The Collection of the DocumentAttributeTypes
84       */
85      ReferenceList selectAttributeTypeList( Locale locale );
86  
87      /**
88       * Load the list of attributeTypeParameters
89       *
90       * @param strAttributeTypeCode
91       * @return The Collection of the AttributeTypeParameters
92       */
93      List<AttributeTypeParameter> selectAttributeTypeParameterList( String strAttributeTypeCode );
94  
95      /**
96       * Load the list of documentAttributeTypes
97       *
98       * @return The Collection of the DocumentAttributeTypes
99       */
100     Collection<AttributeType> selectDocumentAttributeTypeList(  );
101 
102     /**
103      * Update the record in the table
104      *
105      * @param documentAttributeType The reference of documentAttributeType
106      */
107     void store( AttributeType documentAttributeType );
108 }