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.portal.service.i18n.I18nService;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.Collection;
41 import java.util.List;
42 import java.util.Locale;
43
44
45 /**
46 * This class provides instances management methods (create, find, ...) for DocumentAttributeType objects
47 */
48 public final class AttributeTypeHome
49 {
50 // Static variable pointed at the DAO instance
51 private static IAttributeTypeDAO _dao = SpringContextService.getBean( "document.attributeTypeDAO" );
52
53 /**
54 * Private constructor - this class need not be instantiated
55 */
56 private AttributeTypeHome( )
57 {
58 }
59
60 /**
61 * Creation of an instance of documentAttributeType
62 *
63 * @param documentAttributeType The instance of the documentAttributeType which contains the informations to store
64 * @return The instance of documentAttributeType which has been created with its primary key.
65 */
66 public static AttributeType/../../../../../fr/paris/lutece/plugins/document/business/attributes/AttributeType.html#AttributeType">AttributeType create( AttributeType documentAttributeType )
67 {
68 _dao.insert( documentAttributeType );
69
70 return documentAttributeType;
71 }
72
73 /**
74 * Update of the documentAttributeType which is specified in parameter
75 *
76 * @param documentAttributeType The instance of the documentAttributeType which contains the data to store
77 * @return The instance of the documentAttributeType which has been updated
78 */
79 public static AttributeType/../../../../../fr/paris/lutece/plugins/document/business/attributes/AttributeType.html#AttributeType">AttributeType update( AttributeType documentAttributeType )
80 {
81 _dao.store( documentAttributeType );
82
83 return documentAttributeType;
84 }
85
86 /**
87 * Remove the DocumentAttributeType whose identifier is specified in parameter
88 *
89 * @param documentAttributeType The DocumentAttributeType object to remove
90 */
91 public static void remove( AttributeType documentAttributeType )
92 {
93 _dao.delete( documentAttributeType );
94 }
95
96 ///////////////////////////////////////////////////////////////////////////
97 // Finders
98
99 /**
100 * Returns an instance of a documentAttributeType whose identifier is specified in parameter
101 *
102 * @param nKey The Primary key of the documentAttributeType
103 * @return An instance of documentAttributeType
104 */
105 public static AttributeType findByPrimaryKey( int nKey )
106 {
107 return _dao.load( nKey );
108 }
109
110 /**
111 * Returns a collection of documentAttributeTypes objects
112 * @return A collection of documentAttributeTypes
113 */
114 public static Collection<AttributeType> findAll( )
115 {
116 return _dao.selectDocumentAttributeTypeList( );
117 }
118
119 /**
120 * Returns a ReferenceList of AttributeTypes objects
121 * @return A ReferenceList of AttributeTypes
122 * @param locale The locale
123 */
124 public static ReferenceList getAttributeTypesList( Locale locale )
125 {
126 return _dao.selectAttributeTypeList( locale );
127 }
128
129 /**
130 * Gets managers list
131 * @return A list of attribute managers
132 */
133 public static ReferenceList getAttributeManagersList( )
134 {
135 return _dao.getAttributeManagersList( );
136 }
137
138 /**
139 * Get Attribute type parameters list
140 * @param strAttributeTypeCode The attribute type code
141 * @param locale The locale
142 * @return A list of attribute parameters list
143 */
144 public static List<AttributeTypeParameter> getAttributeTypeParameterList( String strAttributeTypeCode, Locale locale )
145 {
146 List<AttributeTypeParameter> listParameters = _dao.selectAttributeTypeParameterList( strAttributeTypeCode );
147
148 return (List<AttributeTypeParameter>) I18nService.localizeCollection( listParameters, locale );
149 }
150 }