com.atlassian.jira.index.property
Interface EntityPropertyIndexDocumentManager

All Known Implementing Classes:

EntityPropertyIndexDocumentManagerImpl

public interface EntityPropertyIndexDocumentManager

Manager for objects describing how the entity properties are indexed.

Since:

v6.2

Method Summary

Iterable<EntityPropertyIndexDocument>	getDocumentsForEntity(String entityKey)
Iterable<EntityPropertyIndexDocument>	getDocumentsForPlugin(String pluginKey)
void	put(String pluginKey, String moduleKey, String entityKey, String 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

getDocumentsForPlugin

Iterable<EntityPropertyIndexDocument> getDocumentsForPlugin(String pluginKey)

Parameters:

pluginKey - the key of the plugin.

Returns:

all EntityPropertyIndexDocument for the given plugin key.

getDocumentsForEntity

Iterable<EntityPropertyIndexDocument> getDocumentsForEntity(String entityKey)

Parameters:

entityKey - name of entity eg. issue, project etc

Returns:

all EntityPropertyIndexDocument for the given plugin key.

put

void put(String pluginKey,
         String moduleKey,
         String entityKey,
         String 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.

entityKey - the key/name for entity eg. issue, project.

document - the description of entity's indexing.

remove

void remove(String pluginKey)

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

Parameters:

pluginKey - the key of the plugin.