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