LifeIndexer.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.search.service.indexer;

import java.util.List;

/**
 * 
 * Initial date: 05.03.2013<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 */
public interface LifeIndexer {
	
	public String getSupportedTypeName();
	
	/**
	 * Trigger a full index
	 * @param indexWriter
	 */
	public void fullIndex(LifeFullIndexer indexWriter);

	/**
	 * Trigger only the specificied object/document
	 * @param key
	 * @param indexWriter
	 */
	public void indexDocument(List<Long> key, LifeFullIndexer indexWriter);
	
	public void deleteDocument(Long key, LifeFullIndexer indexWriter);
	
}