EarlyServerProxy

All Known Implementing Classes:

MockServerProxy, RealEarlyServerProxy
```
public interface EarlyServerProxy
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NetGameModel`	`acceptTrade(boolean willAccept)` Notifies the server whether this player has decided to accept or reject a trade
`void`	`addAI(AIType aiType)` Adds an AI to the game
`NetGameModel`	`buildCity(VertexLocation vertexLocation)` Notifies the server that the user has decided to build a city
`NetGameModel`	`buildRoad(EdgeLocation edgeLocation, boolean free)` Notifies the server that the user has decided to build a road
`NetGameModel`	`buildSettlement(VertexLocation vertexLocation, boolean free)` Notifies the server that the user has decided to build a settlement
`NetGameModel`	`buyDevCard()` Notifies the server that the user has bought a development card
`NetGame`	`createGame(boolean randomTiles, boolean randomNumbers, boolean randomPorts, java.lang.String name)` Creates a game on the server
`NetGameModel`	`discardCards(java.util.List<java.lang.Integer> resourceList)` Notifies the server that the user has discarded cards
`NetGameModel`	`finishTurn()` Notifies the server that the user has finished his turn
`NetGameModel`	`getGameModel()` Retrieves the game model from the server
`int`	`getUserId()` Gets the player ID
`java.lang.String`	`getUserName()` Gets the current user's name
`void`	`joinGame(int id, CatanColor color)`
`java.util.List<AIType>`	`listAI()`
`java.util.List<NetGame>`	`listGames()` Fetches a list of ongoing games
`boolean`	`loginUser(java.lang.String username, java.lang.String password)` Logs the specified user in and returns a User object if the user was successfully logged in.
`NetGameModel`	`maritimeTrade(int ratio, ResourceType inputResource, ResourceType outputResource)` Notifies the server that the user has decided to initiate a maritime trade
`NetGameModel`	`monopolyCard(ResourceType resource)` Notifies the server that the user has played a monopoly card
`NetGameModel`	`monumentCard()` Notifies the server that the user has played a monument card
`NetGameModel`	`offerTrade(java.util.List<java.lang.Integer> resourceList, int receiver)` Notifies the server that the user has decided to offer a trade to another player
`boolean`	`registerUser(java.lang.String username, java.lang.String password)` Registers a user with the specified username and password
`NetGameModel`	`roadBuildingCard(EdgeLocation location1, EdgeLocation location2)` Notifies the server that the user has played a road building card
`NetGameModel`	`robPlayer(int victimIndex, HexLocation location)` Notifies the server that the user has decided to rob another player
`NetGameModel`	`rollNumber(int roll)` Reports the result of a dice roll to the server
`NetGameModel`	`sendChat(java.lang.String content)` Sends a chat message from the specified user to the server
`NetGameModel`	`soldierCard(int victimIndex, HexLocation hexLocation)` Notifies the server that the user has played a soldier card
`NetGameModel`	`yearOfPlentyCard(ResourceType resource1, ResourceType resource2)` Notifies the server that the user has played a year of plenty card

- Method Detail
  - loginUser
```
boolean loginUser(java.lang.String username,
                  java.lang.String password)
           throws ServerProxyException
```
    Logs the specified user in and returns a User object if the user was successfully logged in. If not, a null user is returned
    
    Parameters:
    
    username - The username of the user to log in
    
    password - The password of the user to log in
    
    Returns:
    
    boolean true when the user could be logged in, false when he couldn't
    
    Throws:
    
    ServerProxyException - if the user could not be logged in
  - registerUser
```
boolean registerUser(java.lang.String username,
                     java.lang.String password)
              throws ServerProxyException
```
    Registers a user with the specified username and password
    
    Parameters:
    
    username - The username of the user to be registered
    
    password - The password of the user to be registered
    
    Returns:
    
    boolean true when the user could be registered, false when he couldn't
    
    Throws:
    
    ServerProxyException - if this user could not be registered
  - listGames
```
java.util.List<NetGame> listGames()
                           throws ServerProxyException
```
    Fetches a list of ongoing games
    
    Returns:
    
    a list of all ongoing games on the server
    
    Throws:
    
    ServerProxyException
  - getUserName
```
java.lang.String getUserName()
                      throws ServerProxyException
```
    Gets the current user's name
    
    Returns:
    
    Throws:
    
    ServerProxyException - if not logged in
  - getUserId
```
int getUserId()
```
    Gets the player ID
    
    Returns:
  - createGame
```
NetGame createGame(boolean randomTiles,
                   boolean randomNumbers,
                   boolean randomPorts,
                   java.lang.String name)
            throws ServerProxyException
```
    Creates a game on the server
    
    Parameters:
    
    randomTiles - Whether the server should place random tiles
    
    randomNumbers - Whether the server should place random number chits
    
    randomPorts - Whether the server should place random ports
    
    name - The name of the game to be created
    
    Returns:
    
    a ProxyGame object that represents the game that was created
    
    Throws:
    
    ServerProxyException - if something goes wrong
  - joinGame
```
void joinGame(int id,
              CatanColor color)
       throws ServerProxyException
```
    Parameters:
    
    color - the color the user wishes to represent him
    
    Throws:
    
    ServerProxyException - if something goes wrong
  - getGameModel
```
NetGameModel getGameModel()
                   throws ServerProxyException
```
    Retrieves the game model from the server
    
    Returns:
    
    a NetGameModel object
    
    Throws:
    
    ServerProxyException - if something goes wrong
  - addAI
```
void addAI(AIType aiType)
    throws ServerProxyException
```
    Adds an AI to the game
    
    Parameters:
    
    aiType - the type of AI the user wishes to add
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - listAI
```
java.util.List<AIType> listAI()
                       throws ServerProxyException
```
    Returns:
    
    a list of supported AI player types
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - sendChat
```
NetGameModel sendChat(java.lang.String content)
               throws ServerProxyException
```
    Sends a chat message from the specified user to the server
    
    Parameters:
    
    content - The content of the chat message
    
    Returns:
    
    A NetGameModel object
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - rollNumber
```
NetGameModel rollNumber(int roll)
                 throws ServerProxyException
```
    Reports the result of a dice roll to the server
    
    Parameters:
    
    roll - The result of the user's roll
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - robPlayer
```
NetGameModel robPlayer(int victimIndex,
                       HexLocation location)
                throws ServerProxyException
```
    Notifies the server that the user has decided to rob another player
    
    Parameters:
    
    victimIndex - The index of the victim of the user's robbing
    
    location - The new hex location of the robber
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - finishTurn
```
NetGameModel finishTurn()
                 throws ServerProxyException
```
    Notifies the server that the user has finished his turn
    
    Parameters:
    
    user - The User who has finished his turn
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - buyDevCard
```
NetGameModel buyDevCard()
                 throws ServerProxyException
```
    Notifies the server that the user has bought a development card
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - yearOfPlentyCard
```
NetGameModel yearOfPlentyCard(ResourceType resource1,
                              ResourceType resource2)
                       throws ServerProxyException
```
    Notifies the server that the user has played a year of plenty card
    
    Parameters:
    
    resource1 - The first chosen resource
    
    resource2 - The second chosen resource
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - roadBuildingCard
```
NetGameModel roadBuildingCard(EdgeLocation location1,
                              EdgeLocation location2)
                       throws ServerProxyException
```
    Notifies the server that the user has played a road building card
    
    Parameters:
    
    location1 - The EdgeLocation location of the first road
    
    location2 - The EdgeLocation location of the second card
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - soldierCard
```
NetGameModel soldierCard(int victimIndex,
                         HexLocation hexLocation)
                  throws ServerProxyException
```
    Notifies the server that the user has played a soldier card
    
    Parameters:
    
    victimIndex - The index of the player who is being robbed
    
    hexLocation - The new hex location of the robber
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - monopolyCard
```
NetGameModel monopolyCard(ResourceType resource)
                   throws ServerProxyException
```
    Notifies the server that the user has played a monopoly card
    
    Parameters:
    
    resource - The resource that the player has chosen to have a monopoly on
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - monumentCard
```
NetGameModel monumentCard()
                   throws ServerProxyException
```
    Notifies the server that the user has played a monument card
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - buildRoad
```
NetGameModel buildRoad(EdgeLocation edgeLocation,
                       boolean free)
                throws ServerProxyException
```
    Notifies the server that the user has decided to build a road
    
    Parameters:
    
    edgeLocation - The edge location of the road
    
    free - Whether this road was free (only true during the set up phases)
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - buildSettlement
```
NetGameModel buildSettlement(VertexLocation vertexLocation,
                             boolean free)
                      throws ServerProxyException
```
    Notifies the server that the user has decided to build a settlement
    
    Parameters:
    
    vertexLocation - The vertex location of the settlement
    
    free - Whether this settlement was free (only true during the set up phases)
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - buildCity
```
NetGameModel buildCity(VertexLocation vertexLocation)
                throws ServerProxyException
```
    Notifies the server that the user has decided to build a city
    
    Parameters:
    
    vertexLocation - The vertex location of the city
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - offerTrade
```
NetGameModel offerTrade(java.util.List<java.lang.Integer> resourceList,
                        int receiver)
                 throws ServerProxyException
```
    Notifies the server that the user has decided to offer a trade to another player
    
    Parameters:
    
    resourceList - A list of the resources that the user wishes to trade, in this order: brick, ore, sheep, wheat, and wood. Negative values denotes that this user will give these resources, and positive values denote the resources that will be received
    
    receiver - The index of the player who will receive this trade offer
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - acceptTrade
```
NetGameModel acceptTrade(boolean willAccept)
                  throws ServerProxyException
```
    Notifies the server whether this player has decided to accept or reject a trade
    
    Parameters:
    
    willAccept - true if the user will accept the trade, false if not
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - maritimeTrade
```
NetGameModel maritimeTrade(int ratio,
                           ResourceType inputResource,
                           ResourceType outputResource)
                    throws ServerProxyException
```
    Notifies the server that the user has decided to initiate a maritime trade
    
    Parameters:
    
    ratio - The ratio of resources demanded by the harbor
    
    inputResource - The resources traded away
    
    outputResource - The resource received
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user
  - discardCards
```
NetGameModel discardCards(java.util.List<java.lang.Integer> resourceList)
                   throws ServerProxyException
```
    Notifies the server that the user has discarded cards
    
    Parameters:
    
    resourceList - A list of integers that denotes how many of each resource the user will discard. The order is brick, ore, sheep, wheat, and wood
    
    Returns:
    
    a NetGameModel object that reflects the current state of the Game
    
    Throws:
    
    ServerProxyException - if there is no logged in user

Interface EarlyServerProxy

Method Summary

Method Detail

loginUser

registerUser

listGames

getUserName

getUserId

createGame

joinGame

getGameModel

addAI

listAI

sendChat

rollNumber

robPlayer

finishTurn

buyDevCard

yearOfPlentyCard

roadBuildingCard

soldierCard

monopolyCard

monumentCard

buildRoad

buildSettlement

buildCity

offerTrade

acceptTrade

maritimeTrade

discardCards