com.atlassian.jira.index.property
Interface PluginIndexConfigurationManager

All Known Implementing Classes:

CachingPluginIndexConfigurationManager, OfBizPluginIndexConfigurationManager

public interface PluginIndexConfigurationManager

Manager for objects describing how the entity properties are indexed.

Since:

v6.2

Method Summary

Iterable<PluginIndexConfiguration>	getDocumentsForEntity(String entityKey)
void	put(String pluginKey, String moduleKey, IndexDocumentConfiguration document) Sets the description of entity's indexing for the given plugin and module's keys.
void	remove(String pluginKey) Removes the description of entity's indexing for the given plugin.

Method Detail

getDocumentsForEntity

Iterable<PluginIndexConfiguration> getDocumentsForEntity(@Nonnull
                                                         String entityKey)

Parameters:

entityKey - name of entity eg. issue, project etc

Returns:

all EntityPropertyIndexDocument for the given plugin key.

put

void put(@Nonnull
         String pluginKey,
         @Nonnull
         String moduleKey,
         @Nonnull
         IndexDocumentConfiguration document)

Sets the description of entity's indexing for the given plugin and module's keys.

Parameters:

pluginKey - the key of the plugin.

moduleKey - the key of the module.

document - the description of entity's indexing.

remove

void remove(@Nonnull
            String pluginKey)

Removes the description of entity's indexing for the given plugin.

Parameters:

pluginKey - the key of the plugin.