View Javadoc
1   /*
2    * Copyright (c) 2002-2021, City of 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.poll.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.List;
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for PollFormQuestion objects
45   */
46  public final class PollFormQuestionHome
47  {
48      // Static variable pointed at the DAO instance
49      private static IPollFormQuestionDAO _dao = SpringContextService.getBean( "poll.pollFormQuestionDAO" );
50      private static Plugin _plugin = PluginService.getPlugin( "poll" );
51  
52      /**
53       * Private constructor - this class need not be instantiated
54       */
55      private PollFormQuestionHome( )
56      {
57      }
58  
59      /**
60       * Create an instance of the pollFormQuestion class
61       * 
62       * @param pollFormQuestion
63       *            The instance of the PollFormQuestion which contains the informations to store
64       * @return The instance of pollFormQuestion which has been created with its primary key.
65       */
66      public static PollFormQuestion/../../../fr/paris/lutece/plugins/poll/business/PollFormQuestion.html#PollFormQuestion">PollFormQuestion create( PollFormQuestion pollFormQuestion )
67      {
68          _dao.insert( pollFormQuestion, _plugin );
69  
70          return pollFormQuestion;
71      }
72  
73      /**
74       * Update of the pollFormQuestion which is specified in parameter
75       * 
76       * @param pollFormQuestion
77       *            The instance of the PollFormQuestion which contains the data to store
78       * @return The instance of the pollFormQuestion which has been updated
79       */
80      public static PollFormQuestion/../../../fr/paris/lutece/plugins/poll/business/PollFormQuestion.html#PollFormQuestion">PollFormQuestion update( PollFormQuestion pollFormQuestion )
81      {
82          _dao.store( pollFormQuestion, _plugin );
83  
84          return pollFormQuestion;
85      }
86  
87      /**
88       * Remove the pollFormQuestion whose identifier is specified in parameter
89       * 
90       * @param nKey
91       *            The pollFormQuestion Id
92       */
93      public static void remove( int nKey )
94      {
95          _dao.delete( nKey, _plugin );
96      }
97  
98      /**
99       * Returns an instance of a pollFormQuestion whose identifier is specified in parameter
100      * 
101      * @param nKey
102      *            The pollFormQuestion primary key
103      * @return an instance of PollFormQuestion
104      */
105     public static PollFormQuestion findByPrimaryKey( int nKey )
106     {
107         return _dao.load( nKey, _plugin );
108     }
109 
110     /**
111      * Load the data of all the pollFormQuestion objects and returns them as a list
112      * 
113      * @return the list which contains the data of all the pollFormQuestion objects
114      */
115     public static List<PollFormQuestion> getPollFormQuestionsList( )
116     {
117         return _dao.selectPollFormQuestionsList( _plugin );
118     }
119 
120     /**
121      * Load the id of all the pollFormQuestion objects and returns them as a list
122      * 
123      * @return the list which contains the id of all the pollFormQuestion objects
124      */
125     public static List<Integer> getIdPollFormQuestionsList( )
126     {
127         return _dao.selectIdPollFormQuestionsList( _plugin );
128     }
129 
130     /**
131      * Load the data of all the pollFormQuestion objects and returns them as a referenceList
132      * 
133      * @return the referenceList which contains the data of all the pollFormQuestion objects
134      */
135     public static ReferenceList getPollFormQuestionsReferenceList( )
136     {
137         return _dao.selectPollFormQuestionsReferenceList( _plugin );
138     }
139 
140     /**
141      * Load the data of all the PollFormQuestion objects and returns them as a referenceList
142      * 
143      * @return the referenceList which contains the data of all the PollFormQuestion objects
144      */
145     public static List<PollFormQuestion> getPollFormQuestionListByFormId( int nIdPollForm, int nFormId )
146     {
147         return _dao.selectPollFormQuestionListByFormId( nIdPollForm, nFormId, _plugin );
148     }
149 
150     /**
151      * Returns an instance of PollFormQuestion whose question identifier is specified in parameter
152      * 
153      * @param nKey
154      *            The optionalQuestionIndexation primary key
155      * @return an instance of OptionalQuestionIndexation
156      */
157     public static PollFormQuestion findByQuestionId( int nIdPollForm, int nQuestionId )
158     {
159         return _dao.loadByQuestionId( nIdPollForm, nQuestionId, _plugin );
160     }
161 }