View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.address.service;
35  
36  import fr.paris.lutece.plugins.address.business.jaxb.Adresse;
37  import fr.paris.lutece.util.ReferenceList;
38  
39  import java.rmi.RemoteException;
40  
41  import javax.servlet.http.HttpServletRequest;
42  
43  /**
44   *
45   */
46  public interface IAddressService
47  {
48      /**
49       * @throws RemoteException
50       *             the RemoteExecption
51       * @param request
52       *            Request
53       * @param labeladresse
54       *            the label adress
55       * @return the XML flux of all adress corresponding
56       *
57       */
58      ReferenceList searchAddress( HttpServletRequest request, String labeladresse ) throws RemoteException;
59  
60      /**
61       * @throws RemoteException
62       *             the RemoteExecption
63       * @param request
64       *            Request
65       * @param labeladresse
66       *            the label adress
67       * @param strArrondissement
68       *            Arrondissement
69       * @return the XML flux of all adress corresponding
70       *
71       */
72      ReferenceList searchAddress( HttpServletRequest request, String labeladresse, String strArrondissement ) throws RemoteException;
73  
74      /**
75       * @throws RemoteException
76       *             the RemoteExecption
77       * @param strSRID
78       *            the srsid
79       * @param request
80       *            Request
81       * @param labeladresse
82       *            the label adress
83       * @param strArrondissement
84       *            Arrondissement
85       * @return the XML flux of all adress corresponding
86       *
87       */
88      ReferenceList searchAddress( HttpServletRequest request, String labeladresse, String strSRID, String strArrondissement ) throws RemoteException;
89  
90      /**
91       * @throws RemoteException
92       *             the RemoteExecption
93       * @param request
94       *            Request
95       * @param id
96       *            the adress id
97       * @param bIsTest
98       *            if true test connect at web service, if false search an adress
99       * @return the XML flux of an adress
100      *
101      */
102     Adresse getAdresseInfo( HttpServletRequest request, long id, boolean bIsTest ) throws RemoteException;
103 
104     /**
105      * Finds the geolocalsation. Uses a default RSID.
106      * 
107      * @throws RemoteException
108      *             the RemoteExecption
109      * @param request
110      *            Request
111      * @param bIsTest
112      *            if true test connect at web service, if false search an adress
113      * @return the XML flux of an adress
114      * @see WebServiceAddressService#getGeolocalisation(HttpServletRequest, String, String, boolean)
115      *
116      */
117     public Adresse getGeolocalisation( HttpServletRequest request, String addresse, String date, boolean bIsTest ) throws RemoteException;
118 
119     /**
120      * @throws RemoteException
121      *             the RemoteExecption
122      * @param request
123      *            Request
124      * @param id
125      *            the adress id
126      * @param bIsTest
127      *            if true test connect at web service, if false search an adress
128      * @return the XML flux of an adress
129      *
130      */
131     Adresse getGeolocalisation( HttpServletRequest request, long id, String strAddress, String strDate, boolean bIsTest ) throws RemoteException;
132 }