1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.documentlibrary.util;
24  
25  import com.liferay.portal.kernel.search.Document;
26  import com.liferay.portal.kernel.search.SearchException;
27  
28  import java.util.Date;
29  
30  /**
31   * <a href="DLIndexer.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Brian Wing Shun Chan
34   */
35  public interface DLIndexer {
36  
37      public void addFile(
38              long companyId, String portletId, long groupId, long repositoryId,
39              String fileName)
40          throws SearchException;
41  
42      public void addFile(
43              long companyId, String portletId, long groupId, long repositoryId,
44              String fileName, long fileEntryId, String properties,
45              Date modifiedDate, String[] tagsCategories, String[] tagsEntries)
46          throws SearchException;
47  
48      public void deleteFile(
49              long companyId, String portletId, long repositoryId,
50              String fileName)
51          throws SearchException;
52  
53      public Document getFileDocument(
54              long companyId, String portletId, long groupId, long repositoryId,
55              String fileName)
56          throws SearchException;
57  
58      public Document getFileDocument(
59              long companyId, String portletId, long groupId, long repositoryId,
60              String fileName, long fileEntryId, String properties,
61              Date modifiedDate, String[] tagsCategories, String[] tagsEntries)
62          throws SearchException;
63  
64      public String getFileUID(
65          String portletId, long repositoryId, String fileName);
66  
67      public void updateFile(
68              long companyId, String portletId, long groupId, long repositoryId,
69              String fileName, long fileEntryId, String properties,
70              Date modifiedDate, String[] tagsCategories, String[] tagsEntries)
71          throws SearchException;
72  
73  }