1 /*
2 * Copyright (c) 2002-2023, 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.referentielfo.v1.rs;
35
36 import fr.paris.lutece.plugins.referentielfo.v1.model.CommuneDto;
37 import fr.paris.lutece.plugins.referentielfo.v1.model.CommuneSearchRequest;
38 import fr.paris.lutece.plugins.referentielfo.v1.model.exception.ReferentielException;
39
40 import java.util.List;
41 import java.util.Optional;
42
43 public interface IReferentielCommuneService
44 {
45
46 /**
47 * recherche par libellé partiel ou code postal partiel pour autocomplétion
48 * @param labelCommune nom partiel de la commune
49 * @return liste de communes au format JSON
50 * @throws ReferentielException
51 */
52 String rechercherCommunesParLabelOuCP( String labelCommune ) throws ReferentielException;
53
54 /**
55 * recherche par libellé strict
56 * @param labelCommune nom de la commune
57 * @return
58 * @throws ReferentielException
59 */
60 List<CommuneDto> rechercherCommunesParLabel( String labelCommune ) throws ReferentielException;
61
62 /**
63 * recherche par code insee
64 * @param code code insee de la commune
65 * @return commune
66 * @throws ReferentielException
67 */
68 List<CommuneDto> recuperationCommuneParCodeInsee( String code ) throws ReferentielException;
69
70 /**
71 * Recherche par libellé + code postal + code insee
72 * @param communeSearchRequest libelle+codePostal+codeInsee
73 * @return
74 * @throws ReferentielException
75 */
76 CommuneDto recuperationCommuneParLibelleCodePosatlCodeInsee( CommuneSearchRequest communeSearchRequest ) throws ReferentielException;
77
78 List<CommuneDto> rechercheCommuneParLibelleOuCodePostalOuCodeInsee( CommuneSearchRequest communeSearchRequest ) throws ReferentielException;
79 }