/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/search/trunk/search-api/api/src/java/org/sakaiproject/search/dao/SearchIndexBuilderWorkerDao.java $
* $Id: SearchIndexBuilderWorkerDao.java 105078 2012-02-24 23:00:38Z ottenhoff@longsight.com $
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 The Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.search.dao;
import java.io.IOException;
import org.sakaiproject.search.api.SearchIndexBuilderWorker;
public interface SearchIndexBuilderWorkerDao
{
/**
* This method processes the list of document modifications in the list
*
* @param worker
* @param indexBatchSize
* @throws IOException
* @throws HibernateException
*/
void processToDoListTransaction(SearchIndexBuilderWorker worker, int indexBatchSize);
/**
* If the implementation of the SearchIndexBuilder requires that the call aquires a lock
* before processing.
* @return true is a lock should be taken prior to processToDoTransaction
*/
boolean isLockRequired();
/**
* check if the index exists
* @return
*/
boolean indexExists();
/**
* create the index with a minimal profile
* @param worker
*/
void createIndexTransaction(SearchIndexBuilderWorker worker);
}