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.urlrewriteradmin.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.Collection;
41
42
43 /**
44 * This class provides instances management methods (create, find, ...) for UrlRewriterRule objects
45 */
46 public final class UrlRewriterRuleHome
47 {
48 // Static variable pointed at the DAO instance
49 private static final String BEAN_DAO = "urlrewriteradmin.urlRewriterRuleDAO";
50 private static IUrlRewriterRuleDAO/../../fr/paris/lutece/plugins/urlrewriteradmin/business/IUrlRewriterRuleDAO.html#IUrlRewriterRuleDAO">IUrlRewriterRuleDAO _dao = (IUrlRewriterRuleDAO) SpringContextService.getBean( BEAN_DAO );
51 private static Plugin _plugin = PluginService.getPlugin( "urlrewriteradmin" );
52
53 /**
54 * Private constructor - this class need not be instantiated
55 */
56 private UrlRewriterRuleHome( )
57 {
58 }
59
60 /**
61 * Create an instance of the urlRewriterRule class
62 * @param urlRewriterRule The instance of the UrlRewriterRule which contains the informations to store
63 * @return The instance of urlRewriterRule which has been created with its primary key.
64 */
65 public static UrlRewriterRule./../../../fr/paris/lutece/plugins/urlrewriteradmin/business/UrlRewriterRule.html#UrlRewriterRule">UrlRewriterRule create( UrlRewriterRule urlRewriterRule )
66 {
67 _dao.insert( urlRewriterRule, _plugin );
68
69 return urlRewriterRule;
70 }
71
72 /**
73 * Update of the urlRewriterRule which is specified in parameter
74 * @param urlRewriterRule The instance of the UrlRewriterRule which contains the data to store
75 * @return The instance of the urlRewriterRule which has been updated
76 */
77 public static UrlRewriterRule./../../../fr/paris/lutece/plugins/urlrewriteradmin/business/UrlRewriterRule.html#UrlRewriterRule">UrlRewriterRule update( UrlRewriterRule urlRewriterRule )
78 {
79 _dao.store( urlRewriterRule, _plugin );
80
81 return urlRewriterRule;
82 }
83
84 /**
85 * Remove the urlRewriterRule whose identifier is specified in parameter
86 * @param nUrlRewriterRuleId The urlRewriterRule Id
87 */
88 public static void remove( int nUrlRewriterRuleId )
89 {
90 _dao.delete( nUrlRewriterRuleId, _plugin );
91 }
92
93 ///////////////////////////////////////////////////////////////////////////
94 // Finders
95
96 /**
97 * Returns an instance of a urlRewriterRule whose identifier is specified in parameter
98 * @param nKey The urlRewriterRule primary key
99 * @return an instance of UrlRewriterRule
100 */
101 public static UrlRewriterRule findByPrimaryKey( int nKey )
102 {
103 return _dao.load( nKey, _plugin );
104 }
105
106 /**
107 * Load the data of all the urlRewriterRule objects and returns them in form of a collection
108 * @return the collection which contains the data of all the urlRewriterRule objects
109 */
110 public static Collection<UrlRewriterRule> findAll( )
111 {
112 return _dao.selectUrlRewriterRulesList( _plugin );
113 }
114 }