ICommunityRecommendationManager.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.cis.orchestration;

import java.util.List;

import org.societies.api.cis.orchestration.model.IFilter;
import org.societies.api.identity.IIdentity;
import org.societies.api.schema.cis.directory.CisAdvertisementRecord;

/**
 *
 * Interface for Community Recommendation Manager
 *
 * @author Chris Lima
 *
 */
public interface ICommunityRecommendationManager {

	/**
	 * 
	 * Default is 10 results
	 * 
	 * @param limit Maximum results to return
	 */
	public abstract void setLimit(int limit);

	/**
	 * @return the limit
	 */
	public abstract int getLimit();

	/**
	 * 
	 * Return a list of CIS advertisements sorted by relevance. CisAdvertisementRecord enables to retrieve CIS information.
	 * 
	 * @param limit Maximum results to return. Default value if null is 10.
	 * @param primaryfilter An array of filters. The primary filter is applied for exact results. All the filters must match.
	 * @param secondaryfilter An array of filters. The secondary filter is applied for extended results. 
	 * @return list of CIS advertisements sorted by relevance
	 */
	public abstract List<CisAdvertisementRecord> getCISAdvResults(int limit,
			IFilter[] primaryfilter, IFilter[] secondaryfilter);

	/**
	 * 
	 * Return a list of CIS identities sorted by relevance. The IIdentiy list can be used to retrieve more info from the Context Broker
	 * 
	 * @param limit Maximum results to return. Default value if null is 10.
	 * @param primaryfilter An array of filters. The primary filter is applied when you want an exact result
	 * @param secondaryfilter An array of filters. The secondary filter is when not all parameters provide a match
	 * @return list of CIS advertisements sorted by relevance
	 */
	public abstract List<IIdentity> getResults(int limit,
			IFilter[] primaryfilter, IFilter[] secondaryfilter);

}