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