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.wrapper.business;
35
36 import fr.paris.lutece.portal.business.indexeraction.IndexerAction;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.portal.service.search.IndexationService;
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40 import fr.paris.lutece.portal.service.util.AppPropertiesService;
41
42 import java.util.Collection;
43
44
45 /**
46 * This class provides instances management methods (create, find, ...) for Htmlpage objects
47 * @author lenaini
48 */
49 public class WrapperHome
50 {
51 // Static variable pointed at the DAO instance
52 private static IWrapperDAO _dao = (IWrapperDAO) SpringContextService.getPluginBean( "wrapper", "wrapperDAO" );
53
54 /**
55 * Private constructor - this class need not be instantiated
56 */
57 private WrapperHome( )
58 {
59 }
60
61 /**
62 * Creation of an instance of wrapper
63 *
64 * @param wrapper The instance of the wrapper which contains the informations to store
65 * @param plugin The Plugin object
66 * @return The instance of wrapper which has been created with its primary key.
67 */
68 public static Wrapper create( Wrapper wrapper, Plugin plugin )
69 {
70 _dao.insert( wrapper, plugin );
71
72 return wrapper;
73 }
74
75 /**
76 * Update of the wrapper which is specified in parameter
77 *
78 * @param wrapper The instance of the wrapper which contains the data to store
79 * @param plugin The Plugin object
80 * @return The instance of the wrapper which has been updated
81 */
82 public static Wrapper update( Wrapper wrapper, Plugin plugin )
83 {
84 _dao.store( wrapper, plugin );
85 return wrapper;
86 }
87
88 /**
89 * Remove the Htmlpage whose identifier is specified in parameter
90 * @param wrapper The Htmlpage object to remove
91 * @param plugin The Plugin object
92 */
93 public static void remove( Wrapper wrapper, Plugin plugin )
94 {
95 _dao.delete( wrapper, plugin );
96 }
97
98 ///////////////////////////////////////////////////////////////////////////
99 // Finders
100
101 /**
102 * Returns an instance of a wrapper whose identifier is specified in parameter
103 * @param nKey The Primary key of the wrapper
104 * @param plugin The Plugin object
105 * @return An instance of wrapper
106 */
107 public static Wrapper findByPrimaryKey( int nKey, Plugin plugin )
108 {
109 return _dao.load( nKey, plugin );
110 }
111
112 /**
113 * Returns a collection of wrappers objects
114 * @param plugin The Plugin object
115 * @return A collection of wrappers
116 */
117 public static Collection<Wrapper> findAll( Plugin plugin )
118 {
119 return _dao.selectAll( plugin );
120 }
121
122 /**
123 * Returns wrapper object with valid status
124 * @param nKey the page id
125 * @param plugin The Plugin object
126 * @return A wrapper
127 */
128 public static Wrapper findEnabledWrapper( int nKey, Plugin plugin )
129 {
130 return _dao.selectEnabledWrapper( nKey, plugin );
131 }
132
133 /**
134 * Returns a collection of wrappers objects with valid status
135 * @param plugin The Plugin object
136 * @return A collection of wrappers
137 */
138 public static Collection<Wrapper> findEnabledWrapperList( Plugin plugin )
139 {
140 return _dao.selectEnabledWrapperList( plugin );
141 }
142 }