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