Package com.liferay.portal.search.index
Interface IndexStatusManager
@ProviderType
public interface IndexStatusManager
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether all model indexing is disabled.boolean
isIndexReadOnly
(String className) Returns whether indexing is disabled for a given model.void
requireIndexReadWrite
(boolean required) Deprecated.As of Athanasius (7.3.x)void
setIndexReadOnly
(boolean indexReadOnly) Deprecated.As of Athanasius (7.3.x)void
setIndexReadOnly
(String className, boolean indexReadOnly) Deprecated.As of Athanasius (7.3.x)
-
Method Details
-
isIndexReadOnly
boolean isIndexReadOnly()Returns whether all model indexing is disabled.- Returns:
true
if indexing is disabled;false
otherwise- See Also:
-
isIndexReadOnly
Returns whether indexing is disabled for a given model.- Parameters:
className
- the class name of the model- Returns:
true
if indexing is disabled;false
otherwise- See Also:
-
requireIndexReadWrite
Deprecated.As of Athanasius (7.3.x)Forces indexing to be enabled, disregarding further requests to disable. When set totrue
, calls tosetIndexReadOnly(boolean)
will be ignored and model indexing will continue enabled. Instead, any processes requiring indexing to be off should run in a separate session with configuration in place to disable indexing. This API will be removed in a future version.- Parameters:
required
-true
to enforce orfalse
to forfeit requirement to index.- See Also:
-
setIndexReadOnly
Deprecated.As of Athanasius (7.3.x)Disables all model indexing. This is strongly discouraged as it may interfere with other running processes expecting newly created entities to be indexed. Instead, any processes requiring indexing to be off should run in a separate session with configuration in place to disable indexing. This API will be removed in a future version.- Parameters:
indexReadOnly
-true
to disable orfalse
to enable indexing- See Also:
-
setIndexReadOnly
Deprecated.As of Athanasius (7.3.x)Disables indexing for a given model. This is strongly discouraged as it may interfere with other running processes expecting newly created entities to be indexed. Instead, any processes requiring indexing to be off should run in a separate session with configuration in place to disable indexing. This API will be removed in a future version.- Parameters:
className
- the class name of the model to disable indexing forindexReadOnly
-true
to disable orfalse
to enable indexing- See Also:
-