View Javadoc

1   // START LICENSE
2   // JSet - a Java JSet card board game implementation
3   // Copyright (C) 2004 Jerome Lacoste
4   //
5   // This program is free software; you can redistribute it and/or modify
6   // it under the terms of the GNU General Public License as published by
7   // the Free Software Foundation; either version 2 of the License, or (at
8   // your option) any later version.
9   //
10  // This program is distributed in the hope that it will be useful, but
11  // WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // General Public License for more details.
14  //
15  // You should have received a copy of the GNU General Public License
16  // along with this program; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  // END LICENSE
19  
20  package org.cb.jset.server;
21  
22  import org.cb.jset.CardSet;
23  import org.cb.jset.MatchingException;
24  
25  import java.rmi.Remote;
26  import java.rmi.RemoteException;
27  
28  /***
29   * An interface for Remote {@link org.cb.jset.SetGameConnection}.
30   *
31   * @author jerome@coffeebreaks.org - last modified by $LastChangedBy: jerome $
32   * @version $Id: RemoteSetGameConnection.java 130 2004-04-15 05:18:07Z jerome $
33   */
34  public interface RemoteSetGameConnection extends Remote
35  {
36    /***
37     * Used by a registered player to try to match a set of set.
38     * @param set the set to try to match.
39     * @throws MatchingException if the set doesn't match or if a card is not on the board.
40     * @throws java.rmi.RemoteException upon communication related exception on this remote call
41     * @see org.cb.jset.SetGameConnection#matchSet(org.cb.jset.CardSet)
42     */
43    void matchSet(CardSet set) throws RemoteException, MatchingException;
44  
45    /***
46     * Close the game connection, effectively leaving the game.
47     * @throws java.rmi.RemoteException upon communication related exception on this remote call
48     * @see org.cb.jset.SetGameConnection#close()
49     */
50    void close() throws RemoteException;
51  
52    /***
53     * Say wether the game connection is closed or not.
54     * @return <code>true</code> if the connection is closed, <code>false</code> otherwise.
55     * @throws java.rmi.RemoteException upon communication related exception on this remote call
56     * @see org.cb.jset.SetGameConnection#isClosed()
57     */
58    boolean isClosed() throws RemoteException;
59  }