1 /*
2 * Copyright (c) 2002-2023, 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;
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 DocumentPageTemplate objects
42 */
43 public final class DocumentPageTemplateHome
44 {
45 // Static variable pointed at the DAO instance
46 private static IDocumentPageTemplateDAO _dao = SpringContextService.getBean( "document.documentPageTemplateDAO" );
47
48 /** Creates a new instance of DocumentPageTemplateHome */
49 private DocumentPageTemplateHome( )
50 {
51 }
52
53 /**
54 * Creation of an instance of a document page template
55 *
56 * @param documentPageTemplate
57 * template An instance of a page template which contains the informations to store
58 * @return The instance of a page template which has been created with its primary key.
59 */
60 public static DocumentPageTemplate../../fr/paris/lutece/plugins/document/business/DocumentPageTemplate.html#DocumentPageTemplate">DocumentPageTemplate create( DocumentPageTemplate documentPageTemplate )
61 {
62 _dao.insert( documentPageTemplate );
63
64 return documentPageTemplate;
65 }
66
67 /**
68 * Update of the page template which is specified
69 *
70 * @param documentPageTemplate
71 * The instance of the page template which contains the data to store
72 * @return The instance of the page template which has been updated
73 */
74 public static DocumentPageTemplate../../fr/paris/lutece/plugins/document/business/DocumentPageTemplate.html#DocumentPageTemplate">DocumentPageTemplate update( DocumentPageTemplate documentPageTemplate )
75 {
76 _dao.store( documentPageTemplate );
77
78 return documentPageTemplate;
79 }
80
81 /**
82 * Remove the page template whose identifier is specified in parameter
83 *
84 * @param nId
85 * 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
99 * The page template primary key
100 * @return an instance of a page template
101 */
102 public static DocumentPageTemplate findByPrimaryKey( int nKey )
103 {
104 return _dao.load( nKey );
105 }
106
107 /**
108 * Return the list of all the page templates
109 *
110 * @return A collection of page templates objects
111 */
112 public static List<DocumentPageTemplate> getPageTemplatesList( )
113 {
114 return _dao.selectPageTemplatesList( );
115 }
116 }