ICisDirectory.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.android.api.cis.directory;

import org.societies.android.api.css.manager.IServiceManager;
import org.societies.api.schema.cis.directory.CisAdvertisementRecord;

/**
 * @author Babak.Farshchian@sintef.no
 *
 */
public interface ICisDirectory extends IServiceManager {
    //CIS DIRECTORY INTENTS
	public static final String INTENT_RETURN_VALUE = "org.societies.android.platform.community.ReturnValue";
	public static final String FIND_ALL_CIS     = "org.societies.android.platform.community.FIND_ALL_CIS";
	public static final String FILTER_CIS 		= "org.societies.android.platform.community.FILTER_CIS";
	public static final String FIND_CIS_ID      = "org.societies.android.platform.community.FIND_CIS_ID";
	
	public String methodsArray[] = {"findAllCisAdvertisementRecords(String client)",
							 		"findForAllCis(String client, String filter)",
							 		"searchByID(String client, String cis_id)",
									"startService()",
									"stopService()"
									};
	
	/**
	 * Find all Cis Advertisement Records {@link org.societies.api.schema.cis.directory.CisAdvertisementRecord} in the CisDirectory.
	 *
	 * @param callback the callback class of the remote CisDirectory client
	 */
	public CisAdvertisementRecord[] findAllCisAdvertisementRecords(String client);
	
	/**
	 * Find all Cis Advertisement Records {@link org.societies.api.schema.cis.directory.CisAdvertisementRecord} that match the specified filter 
	 *
	 * @param cisFilter the filter to be applied to the CisDirectory database search
	 * @param callback the callback class of the remote Cis Directory client
	 */
	public CisAdvertisementRecord[] findForAllCis(String client, String filter);
	
	
	/**
	 * Search for a advertisement record based on CisID  in the CisDirectory
	 *
	 * @param cis_id ID of cis advertisment to return
	 */
	public CisAdvertisementRecord searchByID(String client, String cis_id);
}