ICSSRemoteManager.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 (IBM),
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.internal.css.management;

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

import org.societies.api.schema.css.directory.CssAdvertisementRecord;
import org.societies.api.schema.cssmanagement.CssAdvertisementRecordDetailed;
import org.societies.api.schema.cssmanagement.CssRecord;
import org.societies.api.schema.cssmanagement.CssRequest;

/**
 * 
 * This interface forms the basis of the CSSManager, a component that will exist
 * on all nodes. Its main tasks are:
 * 
 * 1. Allow a user to register or unregister a CSS 2. Allow a user to login into
 * a CSS 3. Allow a user to logout out of a CSS 3. Add and remove nodes that
 * make up a CSS 4. Get the current CSS profile 5. Allow the status of a device
 * to be changed 6. Synchronise profile data 7. Modify the CSS profile
 * 
 * This interface will be implemented for rich and cloud nodes. This interface
 * is used when calling the CSSManager on a different node.
 */
public interface ICSSRemoteManager {

	/**
	 * Register with chosen Domain Server
	 * 
	 * @param profile
	 * @param callback
	 */
	void registerXMPPServer(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Unregister with chosen Domain Server
	 * 
	 * @param profile
	 * @param callback
	 */
	void unregisterXMPPServer(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Login with chosen Domain server
	 * 
	 * @param profile
	 * @param callback
	 */
	void loginXMPPServer(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Logout from chosen Domain server
	 * 
	 * @param profile
	 * @param callback
	 */
	void logoutXMPPServer(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Login a user to a CSS. The registration of devices included in the
	 * profile is implied.
	 * 
	 * @param profile
	 * @param callback
	 */
	void loginCSS(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Logout the user from a CSS
	 * 
	 * @param profile
	 * @param callback
	 */
	void logoutCSS(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Register a CSS
	 * 
	 * @param profile
	 * @param callback
	 */
	void registerCSS(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Unregister the CSS TODO Is a CSS deleted or made inactive
	 * 
	 * @param profile
	 * @param callback
	 */
	void unregisterCSS(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Register a device(s) with a CSS
	 * 
	 * @param profile
	 * @param callback
	 */
	void registerCSSNode(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Unregister a device(s) from a CSS
	 * 
	 * @param profile
	 * @param callback
	 */
	void unregisterCSSNode(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Get the CSS Profile. This operation will retrieve the local CSS Profile.
	 * If none exists or the local cache is deemed to have expired this will
	 * result in a synchronisation with the cloud node.
	 * 
	 * @param callback
	 */
	void getCssRecord(ICSSManagerCallback callback);

	/**
	 * Modify the CSS Profile
	 * 
	 * @param profile
	 * @param callback
	 */
	void modifyCssRecord(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Change the status a CSS device
	 * 
	 * @param profile
	 * @param callback
	 */
	void changeCSSNodeStatus(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Synchronise the CSS profile. The CSS cloud node's current profile is
	 * synchronised with the local device's cached version
	 * 
	 * @param profile
	 * @param callback
	 */
	void synchProfile(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Set the presence status of the user
	 * 
	 * @param profile
	 * @param callback
	 */
	void setPresenceStatus(CssRecord profile, ICSSManagerCallback callback);

	/**
	 * Return a list of people who I have asked to my friend
	 * 
	 * @return List CssRequest
	 */
	Future<List<CssRequest>> findAllCssFriendRequests();

	/**
	 * Return list of requests to be my friend
	 * 
	 * @return List CssRequest
	 */
	Future<List<CssRequest>> findAllCssRequests();

	/** 
	 * send a request to remote CSS to retrieve CSSAdvertisement records 
	 * 
	 * @return List CssAdvertisementRecordDetailed
	 */
	Future<List<CssAdvertisementRecordDetailed>> getCssAdvertisementRecordsFull();

	/** 
	 * send a request to remote CSS to become "Friends"
	 * 
	 * @param friendCssId
	 */
	void sendCssFriendRequest(String friendCssId);

	/**
	 * Update the status of a CSS Friend Request
	 * 
	 * @param CssRequest
	 */
	void updateCssFriendRequest(CssRequest request);

	/** 
	 * Called by remote CSS in response to your request to join
	 * 
	 * @param callback	 
	 */
	void updateCssRequest(CssRequest request);

	/** 
	 * Get a list of Friend Css's from cloud Css Manger 
	 * 
	 * @param callback
	 */
	void getCssFriends(ICSSManagerCallback callback);

	/** 
	 * Get a list of suggested Friends from cloud Css Manger
	 * 
	 * @param callback
	 */
	void suggestedFriends(ICSSManagerCallback callback);

	/** 
	 * Get a list of Pending CSS Friend Requests
	 * 
	 * @param callback
	 */
	void getFriendRequests(ICSSManagerCallback callback);

	/**
	 * accept/reject a CSS Friend Requests 
	 * 
	 * @param CssRequest
	 */
	void acceptCssFriendRequest(CssRequest request);
	
	/**
	 * Get a list of all CSS Friend Requests
	 * 
	 * 
	 * @param callback
	 */
	 void findAllCssFriendRequests(ICSSManagerCallback callback);
	 
	 /**
	 * Get a list of all CSS Requests
	 * 
	 * 
	 * @param callback
	 */
	 void findAllCssRequests(ICSSManagerCallback callback);	 
	 
	 /**
		 * accept/reject a CSS Friend Requests 
		 * 
		 * @param CssRequest
		 */
		void acceptCssFriendRequestInternal(CssRequest request);
		
	/**
	 * accept/reject a CSS Friend Requests 
	 * 
	 * @param CssRequest
	 */
	 void declineCssFriendRequest(CssRequest request);

}