1 /*
2 * Copyright (c) 2002-2020, 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.plugins.document.business.autopublication;
35
36 import fr.paris.lutece.plugins.document.business.spaces.DocumentSpace;
37 import fr.paris.lutece.portal.business.portlet.Portlet;
38
39 import java.util.Collection;
40
41
42 /**
43 * This class porvides Data Access methods for DocumentAutoPublicationDAO interface
44 *
45 */
46 public interface IDocumentAutoPublicationDAO
47 {
48 /**
49 * Insert a new record in the table document_auto_publication
50 *
51 * @param documentAutoPublication the instance of the
52 * DocumentAutoPublication object to insert
53 */
54 void insert( DocumentAutoPublication documentAutoPublication );
55
56 /**
57 * Loads the data of Document Auto Publication whose identifier is specified in parameter
58 *
59 * @param nPortletId The {@link Portlet} identifier
60 * @param nSpaceId The {@link DocumentSpace} identifier
61 * @return The {@link DocumentAutoPublication} object
62 */
63 DocumentAutoPublication load( int nPortletId, int nSpaceId );
64
65 /**
66 * Loads all data Document Auto Publication
67 *
68 * @return The {@link Collection} of {@link DocumentAutoPublication} object
69 */
70 Collection<DocumentAutoPublication> load( );
71
72 /**
73 * Load the list of Document Auto Publication whose portlet identifier is specified in parameter
74 *
75 * @param nPortletId The {@link Portlet} identifier
76 * @return The {@link Collection} of {@link DocumentAutoPublication} object
77 */
78 Collection<DocumentAutoPublication> selectByPortletId( int nPortletId );
79
80 /**
81 * Load the list of Document Auto Publication whose {@link DocumentSpace} identifier is specified in parameter
82 *
83 * @param nSpaceId The {@link DocumentSpace} identifier
84 * @return The {@link Collection} of {@link DocumentAutoPublication} object
85 */
86 Collection<DocumentAutoPublication> selectBySpaceId( int nSpaceId );
87
88 /**
89 * Update the record in the table
90 *
91 * @param documentAutoPublication The DocumentAutoPublication to update
92 */
93 void store( DocumentAutoPublication documentAutoPublication );
94
95 /**
96 * Delete records from a Document Auto Publication object identifier in the table document_auto_publication
97 *
98 * @param nPortletId the portlet identifier
99 * @param nSpaceId the {@link DocumentSpace} identifier
100 */
101 void delete( int nPortletId, int nSpaceId );
102
103 /**
104 * Delete records from a portlet
105 *
106 * @param nPortletId the portlet identifier
107 */
108 void deleteAllSpaces( int nPortletId );
109 }