1 package org.exoplatform.commons.search.index;
2
3 /**
4 * Created by The eXo Platform SAS
5 * Author : eXoPlatform
6 * exo@exoplatform.com
7 * 10/12/15
8 */
9 public interface IndexingService {
10
11 /**
12 * Add a init operation to the indexing queue to init the index
13 * @param connectorName Name of the connector
14 * @LevelAPI Experimental
15 */
16 void init(String connectorName);
17
18 /**
19 * Add a create operation to the indexing queue
20 * @param connectorName Name of the connector
21 * @param id id of the document
22 * @LevelAPI Experimental
23 */
24 void index(String connectorName, String id);
25
26 /**
27 * Add a update operation to the indexing queue
28 * @param connectorName Name of the connector
29 * @param id id of the document
30 * @LevelAPI Experimental
31 */
32 void reindex(String connectorName, String id);
33
34 /**
35 * Add a delete operation to the indexing queue
36 * @param connectorName Name of the connector
37 * @param id id of the document
38 * @LevelAPI Experimental
39 */
40 void unindex(String connectorName, String id);
41
42 /**
43 * Add a reindex all operation to the indexing queue
44 * @param connectorName Name of the connector
45 * @LevelAPI Experimental
46 */
47 void reindexAll(String connectorName);
48
49 /**
50 * Add a delete all type operation to the indexing queue
51 * @param connectorName Name of the connector
52 * @LevelAPI Experimental
53 */
54 void unindexAll(String connectorName);
55
56 /**
57 * Delete all the operations of the indexing queue
58 * @LevelAPI Experimental
59 */
60 void clearQueue();
61
62 /**
63 * Delete all the operations of the indexing queue for a given entity type
64 * @param entityType Entity type
65 * @LevelAPI Experimental
66 */
67 void clearQueue(String entityType);
68 }