1 /*
2 * Copyright (c) 2002-2020, 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.jasper.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 import java.util.Collection;
40
41 /**
42 * This class provides instances management methods (create, find, ...) for JasperReport objects
43 */
44 public final class JasperReportHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IJasperReportDAO/../../../fr/paris/lutece/plugins/jasper/business/IJasperReportDAO.html#IJasperReportDAO">IJasperReportDAO _dao = (IJasperReportDAO) SpringContextService.getPluginBean( "jasper", "jasperReportDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private JasperReportHome( )
53 {
54 }
55
56 /**
57 * Create an instance of the jasperReport class
58 *
59 * @param jasperReport
60 * The instance of the JasperReport which contains the informations to store
61 * @param plugin
62 * the Plugin
63 * @return The instance of jasperReport which has been created with its primary key.
64 */
65 public static JasperReport./../../../../fr/paris/lutece/plugins/jasper/business/JasperReport.html#JasperReport">JasperReport create( JasperReport jasperReport, Plugin plugin )
66 {
67 _dao.insert( jasperReport, plugin );
68
69 return jasperReport;
70 }
71
72 /**
73 * Update of the jasperReport which is specified in parameter
74 *
75 * @param jasperReport
76 * The instance of the JasperReport which contains the data to store
77 * @param plugin
78 * the Plugin
79 * @return The instance of the jasperReport which has been updated
80 */
81 public static JasperReport./../../../../fr/paris/lutece/plugins/jasper/business/JasperReport.html#JasperReport">JasperReport update( JasperReport jasperReport, Plugin plugin )
82 {
83 _dao.store( jasperReport, plugin );
84
85 return jasperReport;
86 }
87
88 /**
89 * Remove the jasperReport whose identifier is specified in parameter
90 *
91 * @param nJasperReportId
92 * The jasperReport Id
93 * @param plugin
94 * the Plugin
95 */
96 public static void remove( int nJasperReportId, Plugin plugin )
97 {
98 _dao.delete( nJasperReportId, plugin );
99 }
100
101 // /////////////////////////////////////////////////////////////////////////
102 // Finders
103
104 /**
105 * Returns an instance of a jasperReport whose identifier is specified in parameter
106 *
107 * @param nKey
108 * The jasperReport primary key
109 * @param plugin
110 * the Plugin
111 * @return an instance of JasperReport
112 */
113 public static JasperReport findByPrimaryKey( int nKey, Plugin plugin )
114 {
115 return _dao.load( nKey, plugin );
116 }
117
118 /**
119 * Load the data of all the jasperReport objects and returns them in form of a collection
120 *
121 * @param plugin
122 * the Plugin
123 * @return the collection which contains the data of all the jasperReport objects
124 */
125 public static Collection<JasperReport> getJasperReportsList( Plugin plugin )
126 {
127 return _dao.selectJasperReportsList( plugin );
128 }
129
130 /**
131 *
132 * @param strCode
133 * @param plugin
134 * @return
135 */
136 public static JasperReport findByCode( String strCode, Plugin plugin )
137 {
138 return _dao.loadByCode( strCode, plugin );
139 }
140 }