ICssDirectory.java

/**
 * Copyright (c) 2011, SOCIETIES Consortium (WATERFORD INSTITUTE OF TECHNOLOGY (TSSG), HERIOT-WATT UNIVERSITY (HWU), SOLUTA.NET 
 * (SN), GERMAN AEROSPACE CENTRE (Deutsches Zentrum fuer Luft- und Raumfahrt e.V.) (DLR), Zavod za varnostne tehnologije
 * informacijske družbe in elektronsko poslovanje (SETCCE), INSTITUTE OF COMMUNICATION AND COMPUTER SYSTEMS (ICCS), LAKE
 * COMMUNICATIONS (LAKE), INTEL PERFORMANCE LEARNING SOLUTIONS LTD (INTEL), PORTUGAL TELECOM INOVAÇÃO, SA (PTIN), IBM Corp., 
 * INSTITUT TELECOM (ITSUD), AMITEC DIACHYTI EFYIA PLIROFORIKI KAI EPIKINONIES ETERIA PERIORISMENIS EFTHINIS (AMITEC), TELECOM 
 * ITALIA S.p.a.(TI),  TRIALOG (TRIALOG), Stiftelsen SINTEF (SINTEF), NEC EUROPE LTD (NEC))
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.societies.api.css.directory;

import java.util.List;
import java.util.concurrent.Future;

import org.societies.api.schema.css.directory.CssAdvertisementRecord;
import org.societies.utilities.annotations.SocietiesExternalInterface;
import org.societies.utilities.annotations.SocietiesExternalInterface.SocietiesInterfaceType;

/**
 * 
 * @author Perumal Kuppuudaiyar
 * @author Babak.Farshchian@sintef.no
 * @author Maria Mannion
 * 
 */
@SocietiesExternalInterface(type=SocietiesInterfaceType.PROVIDED)
public interface ICssDirectory {
	/**
	 * Description: This method provide interface to add new CSS object to CSS
	 * directory
	 * 
	 * @param css
	 *            object to be added to directory
	 */
	void addCssAdvertisementRecord(CssAdvertisementRecord cssAdvert);

	/**
	 * Description: This method allows to delete specific CSS entry from CSS
	 * Directory
	 * 
	 * @param css
	 *            object to be deleted from directory
	 */
	void deleteCssAdvertisementRecord(CssAdvertisementRecord cssAdvert);

	/**
	 * Description : This method can be used to update the changes in the CSS
	 * which is already exists in the CSS directory
	 * 
	 * @param css
	 *            to be updated or replaced
	 * @param update
	 *            new css object to be placed in the directory
	 */
	void updateCssAdvertisementRecord(CssAdvertisementRecord oldCssAdvert,
			CssAdvertisementRecord updatedCssAdvert);

	/**
	 * Description : Queries list of CSS available in the CSS directory
	 * 
	 * @return list of CssAdvertisementRecord from CSS directory
	 */
	Future<List<CssAdvertisementRecord>> findAllCssAdvertisementRecords();

	/**
	 * Description : Queries list of CSS object with CSS advertisement record
	 * filter
	 * 
	 * @param cssFilter
	 *            for which list of CSS will retrieved from directory
	 * @return list of CssAdvertisementRecords
	 */
	Future<List<CssAdvertisementRecord>> findForAllCss(
			CssAdvertisementRecord cssFilter);
	
	/**
	 * Description : Queries by css id's
	 * 
	 * @param cssidList
	 *            list of id's to return ad rec  
	 * @return list of CssAdvertisementRecords
	 */
	Future<List<CssAdvertisementRecord>> searchByID(
			List<String> cssIdList);
	

}