View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.portal.business.mail;
35  
36  import fr.paris.lutece.portal.service.spring.SpringContextService;
37  
38  /**
39   * This class provides Data Access methods for MailItemQueue objects
40   */
41  public final class MailItemQueueHome
42  {
43      // Static variable pointed at the DAO instance
44      private static IMailItemQueueDAO _dao = SpringContextService.getBean( "mailItemQueueDAO" );
45  
46      /**
47       * Creates a new MailItemQueueHome object.
48       */
49      private MailItemQueueHome( )
50      {
51      }
52  
53      /**
54       * Insert a new mail item in the database queue.
55       * 
56       * @param mailItemQueue
57       *            the mail item to insert
58       */
59      public static void create( MailItemQueue mailItemQueue )
60      {
61          _dao.insert( mailItemQueue );
62      }
63  
64      /**
65       * Delete the mail item record in the table
66       * 
67       * @param nIdMailItemQueue
68       *            The indentifier of the mail item to remove
69       */
70      public static void delete( int nIdMailItemQueue )
71      {
72          _dao.delete( nIdMailItemQueue );
73      }
74  
75      /**
76       * Return the first mail item in the queue
77       * 
78       * @return the first mail item in the queue
79       */
80      public static MailItemQueue getNextMailItemQueue( )
81      {
82          // get the id of the next mail item queue
83          int nIdMailItemQueue = _dao.nextMailItemQueueId( );
84  
85          if ( nIdMailItemQueue != -1 )
86          {
87              // lock the mail item queue before getting mailItemQueue Object
88              _dao.lockMailItemQueue( nIdMailItemQueue );
89  
90              return _dao.load( nIdMailItemQueue );
91          }
92  
93          return null;
94      }
95  
96      /**
97       *
98       * @return the number of mail item present in the queue
99       */
100     public static int getMailItemNumber( )
101     {
102         return _dao.getCountMailItem( );
103     }
104 }