Package com.liferay.portal.search.index
Interface IndexStatusManager
@ProviderType
public interface IndexStatusManager
-
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns whether all model indexing is disabled.booleanisIndexReadOnly(String className) Returns whether indexing is disabled for a given model.voidrequireIndexReadWrite(boolean required) Deprecated.As of Athanasius (7.3.x)voidsetIndexReadOnly(boolean indexReadOnly) Deprecated.As of Athanasius (7.3.x)voidsetIndexReadOnly(String className, boolean indexReadOnly) Deprecated.As of Athanasius (7.3.x)
-
Method Details
-
isIndexReadOnly
boolean isIndexReadOnly()Returns whether all model indexing is disabled.- Returns:
trueif indexing is disabled;falseotherwise- See Also:
-
isIndexReadOnly
Returns whether indexing is disabled for a given model.- Parameters:
className- the class name of the model- Returns:
trueif indexing is disabled;falseotherwise- 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-trueto enforce orfalseto 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-trueto disable orfalseto 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-trueto disable orfalseto enable indexing- See Also:
-