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.service.spring.SpringContextService;
37
38 import java.util.List;
39
40
41 /**
42 * This class provides instances management methods (create, find, ...) for PageTemplate objects
43 */
44 public final class PageTemplateHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IPageTemplateDAO _dao = (IPageTemplateDAO) SpringContextService.getBean( "pageTemplateDAO" );
48
49 /**
50 * Creates a new PageTemplateHome object.
51 */
52 private PageTemplateHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of a page template
58 *
59 * @param pageTemplate template An instance of a page template which contains the informations to store
60 * @return The instance of a page template which has been created with its primary key.
61 */
62 public static PageTemplate create( PageTemplate pageTemplate )
63 {
64 _dao.insert( pageTemplate );
65
66 return pageTemplate;
67 }
68
69 /**
70 * Update of the page template which is specified
71 *
72 * @param pageTemplate The instance of the page template which contains the data to store
73 * @return The instance of the page template which has been updated
74 */
75 public static PageTemplate update( PageTemplate pageTemplate )
76 {
77 _dao.store( pageTemplate );
78
79 return pageTemplate;
80 }
81
82 /**
83 * Remove the page template whose identifier is specified in parameter
84 *
85 * @param nId The identifier of the page template to remove
86 */
87 public static void remove( int nId )
88 {
89 _dao.delete( nId );
90 }
91
92 ///////////////////////////////////////////////////////////////////////////
93 // Finders
94
95 /**
96 * Returns an instance of an page template whose identifier is specified in parameter
97 *
98 * @param nKey The page template primary key
99 * @return an instance of a page template
100 */
101 public static PageTemplate findByPrimaryKey( int nKey )
102 {
103 return _dao.load( nKey );
104 }
105
106 /**
107 * Return the list of all the page templates
108 *
109 * @return A collection of page templates objects
110 */
111 public static List<PageTemplate> getPageTemplatesList( )
112 {
113 return _dao.selectPageTemplatesList( );
114 }
115
116 /**
117 * Checks if a page template is used by a page
118 *
119 * @param nPageTemplateId The identifier of the page Template
120 * @return true if a page template has been used by a page, false otherwise
121 */
122 public static boolean checkStylePageTemplateIsUsed( int nPageTemplateId )
123 {
124 return _dao.checkPageTemplateIsUsed( nPageTemplateId );
125 }
126 }