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
37 /**
38 * This class provides Data Access methods for MailItemQueue objects
39 */
40 public interface IMailItemQueueDAO
41 {
42 /**
43 * Insert a new mail item in the table.
44 * @param mailItemQueue the mail item
45 */
46 void insert( MailItemQueue mailItemQueue );
47
48 /**
49 * return the first mail item in the table
50 * @param nIdMailItemQueue the id of the mail item
51 * @return the first mail item in the table
52 */
53 MailItemQueue load( int nIdMailItemQueue );
54
55 /**
56 * Delete the mail item record in the table
57 * @param nIdMailItemQueue The indentifier of the mail item to remove
58 */
59 void delete( int nIdMailItemQueue );
60
61 /**
62 *
63 * @return the number of mail item present in the core_mail_queue
64 */
65 int getCountMailItem( );
66
67 /**
68 * return the next mail item queue id
69 * @return the next mail item queue id
70 */
71 int nextMailItemQueueId( );
72
73 /**
74 * Lock the mail item
75 * @param nIdMailItemQueue the id of the mail item to lock
76 */
77 void lockMailItemQueue( int nIdMailItemQueue );
78 }