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