1 /*
2 * Copyright (c) 2002-2014, 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.quiz.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 import java.util.Collection;
40
41
42 /**
43 * This class provides instances management methods (create, find, ...) for Quiz
44 * objects
45 */
46 public final class QuizHome
47 {
48 private static IQuizDAO _dao = SpringContextService.getBean( "quiz.quizDAO" );
49
50 /**
51 * Private constructor - this class need not be instantiated
52 */
53 private QuizHome( )
54 {
55 }
56
57 /**
58 * Creation of an instance of an article Quiz
59 *
60 * @param quiz An instance of the Quiz which contains the informations to
61 * store
62 * @param plugin the plugin
63 * @return The instance of the Quiz which has been created
64 */
65 public static Quiz create( Quiz quiz, Plugin plugin )
66 {
67 _dao.insert( quiz, plugin );
68
69 return quiz;
70 }
71
72 /**
73 * Updates of the Quiz instance specified in parameter
74 *
75 * @param quiz An instance of the Quiz which contains the informations to
76 * store
77 * @param plugin the plugin
78 * @return The instance of the Quiz which has been updated.
79 */
80 public static Quiz update( Quiz quiz, Plugin plugin )
81 {
82 _dao.store( quiz, plugin );
83
84 return quiz;
85 }
86
87 /**
88 * Deletes the Quiz instance whose identifier is specified in parameter
89 *
90 * @param nIdQuiz The identifier of the article Quiz to delete in the
91 * database
92 * @param plugin the plugin
93 */
94 public static void remove( int nIdQuiz, Plugin plugin )
95 {
96 _dao.delete( nIdQuiz, plugin );
97 }
98
99 ///////////////////////////////////////////////////////////////////////////
100 // Finders
101
102 /**
103 * Returns an instance of the article Quiz whose identifier is specified in
104 * parameter
105 *
106 * @param nKey The primary key of the article to find in the database
107 * @param plugin the plugin
108 * @return An instance of the Quiz which corresponds to the key
109 */
110 public static Quiz findByPrimaryKey( int nKey, Plugin plugin )
111 {
112 return _dao.load( nKey, plugin );
113 }
114
115 /**
116 * Returns Quiz list
117 *
118 * @param plugin the plugin
119 * @return the list of the Quiz of the database in form of a Quiz Collection
120 * object
121 */
122 public static Collection<Quiz> findAll( Plugin plugin )
123 {
124 return _dao.selectQuizList( plugin );
125 }
126
127 /**
128 * Returns Quiz list
129 *
130 * @param plugin the plugin
131 * @return the list of the Quiz enabled of the database in form of a Quiz
132 * Collection object
133 */
134 public static Collection<Quiz> findAllEnabled( Plugin plugin )
135 {
136 return _dao.selectQuizEnabledList( plugin );
137 }
138
139 /**
140 * Returns the last quiz
141 * @param plugin The plugin
142 *
143 * @return The last quiz
144 */
145 public static Quiz findLastQuiz( Plugin plugin )
146 {
147 return _dao.loadLastQuiz( plugin );
148 }
149 }