1 /*
2 * Copyright (c) 2002-2018, 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.appstore.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 import fr.paris.lutece.util.ReferenceList;
40
41 import java.util.Collection;
42
43 /**
44 * This class provides instances management methods (create, find, ...) for Category objects
45 */
46 public final class CategoryHome
47 {
48 // Static variable pointed at the DAO instance
49 private static ICategoryDAO _dao = (ICategoryDAO) SpringContextService.getBean( "appstore.categoryDAO" );
50 private static Plugin _plugin = PluginService.getPlugin( "appstore" );
51
52 /**
53 * Private constructor - this class need not be instantiated
54 */
55 private CategoryHome( )
56 {
57 }
58
59 /**
60 * Create an instance of the category class
61 *
62 * @param category
63 * The instance of the Category which contains the informations to store
64 * @return The instance of category which has been created with its primary key.
65 */
66 public static Category create( Category category )
67 {
68 _dao.insert( category, _plugin );
69
70 return category;
71 }
72
73 /**
74 * Update of the category which is specified in parameter
75 *
76 * @param category
77 * The instance of the Category which contains the data to store
78 * @return The instance of the category which has been updated
79 */
80 public static Category update( Category category )
81 {
82 _dao.store( category, _plugin );
83
84 return category;
85 }
86
87 /**
88 * Remove the category whose identifier is specified in parameter
89 *
90 * @param nCategoryId
91 * The category Id
92 */
93 public static void remove( int nCategoryId )
94 {
95 _dao.delete( nCategoryId, _plugin );
96 }
97
98 // /////////////////////////////////////////////////////////////////////////
99 // Finders
100
101 /**
102 * Returns an instance of a category whose identifier is specified in parameter
103 *
104 * @param nKey
105 * The category primary key
106 * @return an instance of Category
107 */
108 public static Category findByPrimaryKey( int nKey )
109 {
110 return _dao.load( nKey, _plugin );
111 }
112
113 /**
114 * Load the data of all the category objects and returns them in form of a collection
115 *
116 * @return the collection which contains the data of all the category objects
117 */
118 public static Collection<Category> getCategorysList( )
119 {
120 return _dao.selectCategorysList( _plugin );
121 }
122
123 /**
124 * Gets categories as reference list
125 *
126 * @return The reference list
127 */
128 public static ReferenceList getCategories( )
129 {
130 ReferenceList list = new ReferenceList( );
131
132 for ( Category category : getCategorysList( ) )
133 {
134 list.addItem( category.getId( ), category.getName( ) );
135 }
136
137 return list;
138 }
139 }