/**
 * Copyright 2008-2009 DRIVER PROJECT (ICM UW)
 * Original author: Marek Horst
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-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 eu.dnetlib.data.index.ws.bbq;

/**
 * BBQ mappings container interface.
 * Implementing classes should maintain collecionName <-> bbQuery mappings. 
 * @author Marek Horst
 * @version 0.7.6
 *
 */
public interface IBBQMappingsContainer {
	
	/**
	 * Returns collection name for given bbQuery.
	 * @param bbQuery
	 * @return collection name for given bbQuery
	 */
	public String getCollectionName(String bbQuery);
	
	/**
	 * Sets collecionName <-> bbQuery mapping.
	 * Returns true if bbQuery for given collectionName existed and
	 * was different than the one passed as parameter.  
	 * @param collectionName
	 * @param bbQuery
	 * @return true if bbQuery for given collectionName existed and
	 * was different than the one passed as parameter.
	 * 
	 */
	public boolean setMapping(String collectionName, String bbQuery);
	
	/**
	 * Removes mapping for given collection name.
	 * Returns bbQuery if an entry already existed and was sucessfully removed.
	 * @param collectionName
	 * @return bbQuery if an entry already existed and was sucessfully removed
	 */
	public String removeMapping(String collectionName);

}