Package com.liferay.portal.kernel.search
Interface IndexWriterHelper
@ProviderType
public interface IndexWriterHelper
- Author:
- Michael C. Han
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDocument
(long companyId, Document document, boolean commitImmediately) void
addDocuments
(long companyId, Collection<Document> documents, boolean commitImmediately) void
commit()
void
commit
(long companyId) void
deleteDocument
(long companyId, String uid, boolean commitImmediately) void
deleteDocuments
(long companyId, Collection<String> uids, boolean commitImmediately) void
deleteEntityDocuments
(long companyId, String className, boolean commitImmediately) int
getReindexTaskCount
(long groupId, boolean completed) void
indexKeyword
(long companyId, String querySuggestion, float weight, String keywordType, Locale locale) void
indexQuerySuggestionDictionaries
(long companyId) void
indexQuerySuggestionDictionary
(long companyId, Locale locale) void
indexSpellCheckerDictionaries
(long companyId) void
indexSpellCheckerDictionary
(long companyId, Locale locale) boolean
Deprecated.boolean
isIndexReadOnly
(String className) Deprecated.As of Judson (7.1.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly(String)
void
partiallyUpdateDocument
(long companyId, Document document, boolean commitImmediately) void
partiallyUpdateDocuments
(long companyId, Collection<Document> documents, boolean commitImmediately) reindex
(long userId, String jobName, long[] companyIds, String className, Map<String, Serializable> taskContextMap) reindex
(long userId, String jobName, long[] companyIds, Map<String, Serializable> taskContextMap) void
setIndexReadOnly
(boolean indexReadOnly) Deprecated.As of Wilberforce (7.0.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly(boolean)
void
setIndexReadOnly
(String className, boolean indexReadOnly) Deprecated.As of Judson (7.1.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly(String, boolean)
void
updateDocument
(long companyId, Document document) void
updateDocuments
(long companyId, Collection<Document> documents, boolean commitImmediately) void
updatePermissionFields
(String name, String primKey)
-
Method Details
-
addDocument
void addDocument(long companyId, Document document, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
addDocuments
void addDocuments(long companyId, Collection<Document> documents, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
commit
- Throws:
SearchException
-
commit
- Throws:
SearchException
-
deleteDocument
- Throws:
SearchException
-
deleteDocuments
void deleteDocuments(long companyId, Collection<String> uids, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
deleteEntityDocuments
void deleteEntityDocuments(long companyId, String className, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
getReindexTaskCount
- Throws:
SearchException
-
indexKeyword
void indexKeyword(long companyId, String querySuggestion, float weight, String keywordType, Locale locale) throws SearchException - Throws:
SearchException
-
indexQuerySuggestionDictionaries
- Throws:
SearchException
-
indexQuerySuggestionDictionary
- Throws:
SearchException
-
indexSpellCheckerDictionaries
- Throws:
SearchException
-
indexSpellCheckerDictionary
- Throws:
SearchException
-
isIndexReadOnly
Deprecated.As of Wilberforce (7.0.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly
-
isIndexReadOnly
Deprecated.As of Judson (7.1.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly(String)
-
partiallyUpdateDocument
void partiallyUpdateDocument(long companyId, Document document, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
partiallyUpdateDocuments
void partiallyUpdateDocuments(long companyId, Collection<Document> documents, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
reindex
BackgroundTask reindex(long userId, String jobName, long[] companyIds, Map<String, Serializable> taskContextMap) throws SearchException- Throws:
SearchException
-
reindex
BackgroundTask reindex(long userId, String jobName, long[] companyIds, String className, Map<String, Serializable> taskContextMap) throws SearchException- Throws:
SearchException
-
setIndexReadOnly
Deprecated.As of Wilberforce (7.0.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly(boolean)
-
setIndexReadOnly
Deprecated.As of Judson (7.1.x), replaced bycom.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly(String, boolean)
-
updateDocument
- Throws:
SearchException
-
updateDocuments
void updateDocuments(long companyId, Collection<Document> documents, boolean commitImmediately) throws SearchException - Throws:
SearchException
-
updatePermissionFields
-
com.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly