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.util.ReferenceList;
38
39 import java.util.List;
40
41
42 /**
43 * IQuestionGroupDAO Interface
44 */
45 public interface IQuestionGroupDAO
46 {
47 /**
48 * Insert a new record in the table.
49 * @param nIdQuiz The quiz ID
50 * @param group instance of the QuestionGroup object to inssert
51 * @param plugin the Plugin
52 */
53 void insert( int nIdQuiz, QuestionGroup group, Plugin plugin );
54
55 /**
56 * Update the record in the table
57 * @param group the reference of the QuestionGroup
58 * @param plugin the Plugin
59 */
60 void store( QuestionGroup group, Plugin plugin );
61
62 /**
63 * Delete a record from the table
64 * @param nIdQuiz The Quiz ID
65 * @param nIdGroup int identifier of the QuestionGroup to delete
66 * @param plugin the Plugin
67 */
68 void delete( int nIdQuiz, int nIdGroup, Plugin plugin );
69
70 ///////////////////////////////////////////////////////////////////////////
71 // Finders
72
73 /**
74 * Load the data from the table
75 * @param nKey The identifier of the group
76 * @param plugin the Plugin
77 * @return The instance of the group
78 */
79 QuestionGroup load( int nKey, Plugin plugin );
80
81 /**
82 * Load the data of all the group objects and returns them as a List
83 * @param nIdQuiz The Quiz Id
84 * @param plugin the Plugin
85 * @return The List which contains the data of all the group objects
86 */
87 List<QuestionGroup> selectQuestionGroupsList( int nIdQuiz, Plugin plugin );
88
89 /**
90 * Returns a list of groups
91 * @param nIdQuiz The Quiz ID
92 * @param plugin The plugin
93 * @return The list
94 */
95 ReferenceList selectQuestionGroupsReferenceList( int nIdQuiz, Plugin plugin );
96
97 /**
98 * Delete for a quiz
99 * @param nIdQuiz The Quiz ID
100 * @param plugin The plugin
101 */
102 void deleteByQuiz( int nIdQuiz, Plugin plugin );
103
104 /**
105 * Move up a group
106 * @param nIdQuiz The quiz Id
107 * @param group The group
108 * @param plugin The plugin
109 */
110 void changePositionUp( int nIdQuiz, QuestionGroup group, Plugin plugin );
111
112 /**
113 * Move down a group
114 * @param nIdQuiz The quiz Id
115 * @param group The group
116 * @param plugin The plugin
117 */
118 void changePositionDown( int nIdQuiz, QuestionGroup group, Plugin plugin );
119
120 /**
121 * Find a group by its quiz and position
122 * @param nIdQuiz The quiz ID
123 * @param nPosition The position of the required group
124 * @param plugin the Plugin
125 * @return The requested group, or null if no group has the given position
126 */
127 QuestionGroup selectQuestionGroupByPosition( int nIdQuiz, int nPosition, Plugin plugin );
128
129 /**
130 * Find the id of last group in quiz
131 * @param nIdQuiz the quiz id
132 * @param plugin the plugin
133 * @return the id of corresponding group
134 */
135 int findLastByQuiz( int nIdQuiz, Plugin plugin );
136
137 /**
138 * Check if a quiz has a free HTML group that will display the score of the
139 * quiz
140 * @param nIdQuiz The id of the quiz
141 * @param plugin The plugin
142 * @return True if the quiz has a free HTML group that will display the
143 * result of the quiz, false otherwise
144 */
145 boolean hasGroupDisplayScore( int nIdQuiz, Plugin plugin );
146 }