/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/search/trunk/search-impl/impl/src/java/org/sakaiproject/search/indexer/api/IndexUpdateTransaction.java $
* $Id: IndexUpdateTransaction.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.indexer.api;
import java.util.Iterator;
import java.util.List;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.sakaiproject.search.model.SearchBuilderItem;
import org.sakaiproject.search.transaction.api.IndexTransaction;
import org.sakaiproject.search.transaction.api.IndexTransactionException;
/**
* This represents a transactional index operation
*
* @author ieb
*/
public interface IndexUpdateTransaction extends IndexTransaction
{
/**
* Get the index writer associated with this transaction
*
* @return
* @throws IndexTransactionException
* if the transaction is not open
*/
IndexWriter getIndexWriter() throws IndexTransactionException;
/**
* @return
*/
IndexReader getIndexReader() throws IndexTransactionException;
/**
* Get a list of add items associated with this transaction
*
* @return
* @throws IndexTransactionException
* if the transaction is not open
*/
Iterator<SearchBuilderItem> lockedItemIterator() throws IndexTransactionException;
/**
* @return
*/
String getTempIndex();
/**
* The list of items
*
* @return
*/
List<SearchBuilderItem> getItems();
/**
* Sets the items for the tansaction if the transaction is not open
*
* @param items
* @throws IndexTransactionException
* if the items has already been set, or the transaction is not open
*/
void setItems(List<SearchBuilderItem> items) throws IndexTransactionException;
}