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.Collection;
40
41
42 /**
43 * Interface of quiz profile DAO
44 */
45 public interface IQuizProfileDAO
46 {
47 /**
48 * Creation of an instance of an article Quiz profile
49 *
50 * @param profil An instance of the Quiz profile which contains the
51 * informations to store
52 * @param plugin the plugin
53 */
54 void insert( QuizProfile profil, Plugin plugin );
55
56 /**
57 * Select the list of profile
58 * @param nIdQuiz The quiz ID
59 * @param plugin plugin Quiz
60 * @return profils list
61 */
62 ReferenceList selectQuizProfilsReferenceList( int nIdQuiz, Plugin plugin );
63
64 /**
65 * Return the name of a profile
66 * @param nIdProfil The profile ID
67 * @param plugin plugin Quiz
68 * @return name of the corresponding profile
69 */
70 String getName( int nIdProfil, Plugin plugin );
71
72 /**
73 * Load a profile with its id
74 * @param nKey the id to load
75 * @param plugin plugin Quiz
76 * @return corresponding profile
77 */
78 QuizProfile load( int nKey, Plugin plugin );
79
80 /**
81 * Find all profiles for a quiz
82 * @param nIdQuiz the id quiz
83 * @param plugin plugin Quiz
84 * @return profile list
85 */
86 Collection<QuizProfile> findAll( int nIdQuiz, Plugin plugin );
87
88 /**
89 * Delete a profile
90 * @param nIdProfil the profile id
91 * @param plugin plugin Quiz
92 */
93 void delete( int nIdProfil, Plugin plugin );
94
95 /**
96 * Updates of the {@link QuizProfile} instance specified in parameter
97 * @param quizProfil An instance of the {@link QuizProfile} which contains
98 * the informations to store
99 * @param plugin the plugin
100 */
101 void store( QuizProfile quizProfil, Plugin plugin );
102
103 /**
104 * Delete profiles linked to a quiz
105 * @param nIdQuiz the quiz id
106 * @param plugin plugin Quiz
107 */
108 void deleteByQuiz( int nIdQuiz, Plugin plugin );
109 }