org.eclipse.emf.emfstore.server.backchannel/src/org/eclipse/emf/emfstore/server/backchannel/connection/server/XmlRpcBackchannelInterface.java

/**
 * Copyright (c) 2008-2011 Chair for Applied Software Engineering,
 * Technische Universitaet Muenchen.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 */
package org.eclipse.emf.emfstore.server.backchannel.connection.server;

import org.eclipse.emf.emfstore.server.exceptions.EmfStoreException;
import org.eclipse.emf.emfstore.server.model.ProjectId;
import org.eclipse.emf.emfstore.server.model.SessionId;
import org.eclipse.emf.emfstore.server.model.versioning.events.server.ServerEvent;

/**
 * XML RPC interface for the backchannel.
 * 
 * @author wesendon
 */
public interface XmlRpcBackchannelInterface {

	/**
	 * Returns a server event.
	 * 
	 * @param sessionId
	 *            the ID of the session that is used to retrieve the server event
	 * @param projectId
	 *            the ID of the project
	 * @return a server event
	 * @throws EmfStoreException
	 *             in case any error occurs
	 */
	ServerEvent getEvent(SessionId sessionId, ProjectId projectId) throws EmfStoreException;

	/**
	 * Send a event.
	 * 
	 * @param sessionId
	 *            the ID of the session that will be used to send the event
	 * @param event
	 *            the event to be sent
	 * @param projectId
	 *            the ID of the project
	 * @throws EmfStoreException
	 *             in case any error occurs
	 */
	void sendEvent(SessionId sessionId, ServerEvent event, ProjectId projectId) throws EmfStoreException;

}