View Javadoc
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.crm.business.notification;
35  
36  import fr.paris.lutece.plugins.crm.service.CRMPlugin;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.portal.service.plugin.PluginService;
39  import fr.paris.lutece.portal.service.spring.SpringContextService;
40  
41  import java.util.List;
42  
43  /**
44   *
45   * NotificationHome
46   *
47   */
48  public final class NotificationHome
49  {
50      private static final String BEAN_CRM_NOTIFICATIONDAO = "crm.notificationDAO";
51      private static Plugin _plugin = PluginService.getPlugin( CRMPlugin.PLUGIN_NAME );
52      private static INotificationDAO _dao = SpringContextService.getBean( BEAN_CRM_NOTIFICATIONDAO );
53  
54      /**
55       * Private constructor - this class need not be instantiated
56       */
57      private NotificationHome( )
58      {
59      }
60  
61      /**
62       * Generates a new primary key
63       * 
64       * @return The new primary key
65       */
66      public static int newPrimaryKey( )
67      {
68          return _dao.newPrimaryKey( _plugin );
69      }
70  
71      /**
72       * Insert a new record in the table.
73       * 
74       * @param notification
75       *            instance of the Notification object to insert
76       * @return the key of the newly created notification
77       */
78      public static int create( Notification notification )
79      {
80          return _dao.insert( notification, _plugin );
81      }
82  
83      /**
84       * Update the record in the table
85       * 
86       * @param notification
87       *            the reference of the Notification
88       */
89      public static void update( Notification notification )
90      {
91          _dao.store( notification, _plugin );
92      }
93  
94      /**
95       * Delete a record from the table
96       * 
97       * @param nIdNotification
98       *            int identifier of the notification to delete
99       */
100     public static void remove( int nIdNotification )
101     {
102         _dao.delete( nIdNotification, _plugin );
103     }
104 
105     /**
106      * Delete all records from a given id demand
107      * 
108      * @param nIdDemand
109      *            the id demand
110      */
111     public static void removeByIdDemand( int nIdDemand )
112     {
113         _dao.deleteByIdDemand( nIdDemand, _plugin );
114     }
115 
116     /**
117      * Load the data from the table
118      * 
119      * @param nIdNotification
120      *            The identifier of the notification
121      * @return The instance of the Notification
122      */
123     public static Notification findByPrimaryKey( int nIdNotification )
124     {
125         return _dao.load( nIdNotification, _plugin );
126     }
127 
128     /**
129      * Find all notifications
130      * 
131      * @return a list of {@link Notification}
132      */
133     public static List<Notification> findAll( )
134     {
135         return _dao.selectAll( _plugin );
136     }
137 
138     /**
139      * Find all notification by filter
140      * 
141      * @param nFilter
142      *            the filter
143      * @return a list of {@link Notification}
144      */
145     public static List<Notification> findByFilter( NotificationFilter nFilter )
146     {
147         return _dao.selectNotificationsByFilter( nFilter, _plugin );
148     }
149 }