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.plugins.dila.business.fichelocale.dao;
35
36 import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalDTO;
37
38 import java.util.List;
39
40
41 /**
42 * DAO for {@link LocalDTO}
43 */
44 public interface ILocalDAO
45 {
46 /**
47 * Find a {@link LocalDTO} by its id and type
48 * @param id the id to find
49 * @param type the type
50 * @param idAudience the id audience
51 * @return the corresponding {@link LocalDTO}
52 */
53 LocalDTO findLocalByIdAndTypeAndAudience( Long id, Long type, Long idAudience );
54
55 /**
56 * Find a title by its id and type
57 * @param id the id to find
58 * @param type the type
59 * @param idAudience the id audience
60 * @return the title of corresponding {@link LocalDTO}
61 */
62 String findTitleByIdAndTypeAndAudience( Long id, Long type, Long idAudience );
63
64 /**
65 * Find all {@link LocalDTO}
66 * @return list of all {@link LocalDTO}
67 */
68 List<LocalDTO> findAll( );
69
70 /**
71 * Create a {@link LocalDTO}
72 * @param local the {@link LocalDTO} to create
73 * @param addIdToBreadcrumb <code>true</code> if id must be id to
74 * breadcrumb, <code>false</code> otherwise
75 * @return the id of the new {@link LocalDTO}
76 */
77 Long insert( LocalDTO local, boolean addIdToBreadcrumb );
78
79 /**
80 * Delete a {@link LocalDTO}
81 * @param idLocal the id to delete
82 */
83 void delete( String idLocal );
84
85 /**
86 * Update a {@link LocalDTO}
87 * @param localDTO the {@link LocalDTO} to update
88 * @param addIdToBreadcrumb <code>true</code> if id must be id to
89 * breadcrumb, <code>false</code> otherwise
90 */
91 void store( LocalDTO localDTO, boolean addIdToBreadcrumb );
92
93 /**
94 * Find xml content of {@link LocalDTO} by its id
95 * @param id the id
96 * @return the xml
97 */
98 String findXmlById( Long id );
99
100 /**
101 * Find 10 last fiches for display
102 * @param categoryId the audience to check
103 * @return list of corresponding {@link LocalDTO}
104 */
105 List<LocalDTO> findLastCardsByAudience( Long categoryId );
106
107 /**
108 * Find all {@link LocalDTO} by audience id
109 * @param audienceId the audience id
110 * @return all {@link LocalDTO} in audience id
111 */
112 List<LocalDTO> findAllByAudienceId( Long audienceId );
113 }