1 /*
2 * Copyright (c) 2002-2022, 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.portal.business.style;
35
36 import fr.paris.lutece.portal.business.stylesheet.StyleSheet;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.Collection;
41
42 /**
43 * This class provides instances management methods (create, find, ...) for Style objects
44 */
45 public final class StyleHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IStyleDAO _dao = SpringContextService.getBean( "styleDAO" );
49
50 /**
51 * Creates a new StyleHome object.
52 */
53 private StyleHome( )
54 {
55 }
56
57 /**
58 * Creation of a Style record in the database
59 *
60 * @param style
61 * An instance of the style which contains the informations to store
62 * @return The instance of the style which has been created.
63 */
64 public static Stylef="../../../../../../fr/paris/lutece/portal/business/style/Style.html#Style">Style create( Style style )
65 {
66 _dao.insert( style );
67
68 return style;
69 }
70
71 /**
72 * Updates the record in the database which corresponds to the Style instance specified in parameter.
73 *
74 * @param style
75 * the instance of the style to update
76 */
77 public static void update( Style style )
78 {
79 _dao.store( style );
80 }
81
82 /**
83 * Deletes the record in the database which corresponds to the Style instance specified in parameter.
84 *
85 * @param nStyleId
86 * The identifier of the style
87 */
88 public static void remove( int nStyleId )
89 {
90 _dao.delete( nStyleId );
91 }
92
93 // /////////////////////////////////////////////////////////////////////////
94 // Finders
95
96 /**
97 * Returns an instance of a style whose identifier is specified in parameter
98 *
99 * @param nKey
100 * The primary key of the style to find in the database
101 * @return The Style object which corresponds to the key
102 */
103 public static Style findByPrimaryKey( int nKey )
104 {
105 return _dao.load( nKey );
106 }
107
108 /**
109 * Returns the collection of the Style objects stored in the database
110 *
111 * @return A collection of styles
112 */
113 public static Collection<Style> getStylesList( )
114 {
115 return _dao.selectStylesList( );
116 }
117
118 /**
119 * Returns the collection of the StyleSheet objects associated to the Style
120 *
121 * @param nStyleId
122 * identifier of the style
123 * @return A collection of styles
124 */
125 public static Collection<StyleSheet> getStyleSheetList( int nStyleId )
126 {
127 return _dao.selectStyleSheetList( nStyleId );
128 }
129
130 /**
131 * Returns a reference list which contains all the Portal Components
132 *
133 * @return a reference list
134 */
135 public static ReferenceList getPortalComponentList( )
136 {
137 return _dao.selectPortalComponentList( );
138 }
139
140 /**
141 * Checks if a style has been created in the database with the given portal componenet
142 *
143 * @param nPortalComponentId
144 * The identifier of the portal component
145 * @return true if a style has been created for this portal component, false otherwise
146 */
147 public static boolean checkStylePortalComponent( int nPortalComponentId )
148 {
149 return _dao.checkStylePortalComponent( nPortalComponentId );
150 }
151 }