1 /*
2 * Copyright (c) 2002-2024, 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.grubusiness.business.indexing;
35
36 import java.util.List;
37
38 /**
39 * This interface enables to index any object
40 *
41 * @param <T>
42 * the object to index
43 */
44 public interface IIndexingService<T>
45 {
46 /**
47 * Indexes a object
48 *
49 * @param object
50 * the object to index
51 * @throws IndexingException
52 * if there is an exception during the indexing
53 */
54 void index( T object ) throws IndexingException;
55
56 /**
57 * Index a list of objects
58 *
59 * @param listObjects
60 * the list of objects to index
61 * @throws IndexingException
62 * if there is an exception during the indexing
63 */
64 void indexList( List<T> listObjects ) throws IndexingException;
65
66 /**
67 * Delete index
68 *
69 * @param object
70 * the object to delete
71 * @throws IndexingException
72 * if there is an exception during the deletion
73 */
74 void deleteIndex( T object ) throws IndexingException;
75
76 /**
77 * Deletes the index for all the objects
78 *
79 * @throws IndexingException
80 * if there is an exception during the deletion
81 */
82 void deleteAllIndexes( ) throws IndexingException;
83 }