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