com.atlassian.bamboo.index.quicksearch

Interface QuickSearchDocument

All Known Implementing Classes:

QuickSearchDocumentImpl

public interface QuickSearchDocument

A document representing an entity that can be indexed in lucene and searched via quick search. Ensure to jsonate all properties required for rendering on the implementing class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_FIELD

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.document.Document	getDocument() Get Lucene Document for indexing.
Map<String,String>	getEntity()
long	getId()
QuickSearchDocumentFactory.Type	getType()

Field Detail

SEARCH_FIELD

static final String SEARCH_FIELD

See Also:

Constant Field Values

Method Detail

getType

QuickSearchDocumentFactory.Type getType()

Returns:

string representation of the type of entity the document represents

getId

long getId()

Returns:

Id of the entity

getDocument

@NotNull
org.apache.lucene.document.Document getDocument()

Get Lucene Document for indexing.

Returns:

lucene document

getEntity

Map<String,String> getEntity()