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