package ru.foror.articles.common.domain;

import java.util.Date;

import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.Store;

/**
 * Реализуйте интерфейс для доменов добавляемых в поисковый индекс Lucene.
 * 
 * Аннотации не наследуются в реализующем домене. Поэтому нужно явно копировать 
 * аннотации, представленные в этом интерфейсе, на методы класса. Также нужно 
 * добавить на реализующий домен аннотацию ${@link Indexed}.
 * 
 * @author Alexey Pomogaev foror@mail.com
 */
public interface ISearchResult {
	
	/**
	 * Заголовок.
	 */
	@Field(index=Index.TOKENIZED, store=Store.YES)
	public String getTitle();
	
	/**
	 * Основной текст.
	 */
	@Field(index=Index.TOKENIZED, store=Store.YES)
	public String getPlainText();
	
	/**
	 * Время создания или обновления домена.
	 */
	@Field(index=Index.NO, store=Store.YES)
	public Date getDate();
	
	/**
	 * Имя автора или владелеца объекта.
	 */
	@Field(index=Index.NO, store=Store.YES)
	public String getObjectOwner();
	
}