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.quiz.modules.exportdirectory.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Map;
39
40
41 /**
42 * Interface of DAO for quiz questions and directory entries association
43 */
44 public interface IQuizQuestionEntryDAO
45 {
46 /**
47 * Get the id of the entry associated with the question
48 * @param nIdQuestion The id of the question
49 * @param plugin The plugin
50 * @return the id of the entry associated with the question, or 0 if the
51 * question is not associated with any entry
52 */
53 int getQuestionAssociation( int nIdQuestion, Plugin plugin );
54
55 /**
56 * Associates a question with a entry
57 * @param nIdQuestion The id of the question
58 * @param nIdEntry The id of the entry
59 * @param plugin the plugin
60 */
61 void doAssociateQuestionAndEntry( int nIdQuiz, int nIdQuestion, int nIdEntry, Plugin plugin );
62
63 /**
64 * Associates a score with a entry
65 * @param nIdQuiz The id of the question
66 * @param nIdEntry The id of the entry
67 * @param plugin the plugin
68 */
69 void doAssociateScoreAndEntry( int nIdQuiz, int nIdEntry, Plugin plugin );
70
71 /**
72 * Remove an association between a question and a entry
73 * @param nIdQuestion The id of the question
74 * @param plugin The plugin
75 */
76 void doRemoveAssociation( int nIdQuestion, Plugin plugin );
77
78 /**
79 * Remove an association between a score and a entry
80 * @param nIdQuestion The id of the quiz
81 * @param plugin The plugin
82 */
83 void doRemoveScore( int nIdQuiz, Plugin plugin );
84
85 /**
86 * Get the association between questions of a quiz and directory entries
87 * @param nIdQuiz The id of the quiz
88 * @param plugin The plugin
89 * @return A map which keys are id of questions of the quiz, and values are
90 * id of entries of the directory associated with the quiz
91 */
92 Map<Integer, Integer> getQuestionAssociations( int nIdQuiz, Plugin plugin );
93
94 /**
95 * Get the association between score of a quiz and directory entries
96 * @param nIdQuiz The id of the quiz
97 * @param plugin The plugin
98 * @return A map which keys are id of questions of the quiz, and values are
99 * id of entries of the directory associated with the score quiz
100 */
101 Map<Integer, Integer> getQuestionAssociationScore( int nIdQuiz, Plugin plugin );
102
103 /**
104 * Check if an entry is associated with any question
105 * @param nIdEntry The id of the entry
106 * @param plugin The plugin
107 * @return True if the entry is associated with a question, false otherwise
108 */
109 boolean isEntryAssociated( int nIdEntry, Plugin plugin );
110 }