ks.protocol
Class GameOverCommand

java.lang.Object
  extended byks.common.ArgumentList
      extended byks.common.command.Command
          extended byks.protocol.GameOverCommand
All Implemented Interfaces:
java.io.Serializable

public class GameOverCommand
extends Command

Class to represent the ending of a table at a client.

See Also:
Serialized Form

Field Summary
static java.lang.String NUMHANDSWON
          argument for number of hands won.
static java.lang.String OVERALLSCORE
          argument for overall score.
static java.lang.String TABLENAME
          argument for name of solitaire game.
static java.lang.String TABLETYPE
          argument for type of solitaire game.
static java.lang.String USER
          argument for user.
 
Constructor Summary
GameOverCommand()
          Default Constructor for GameOverCommand.
 
Method Summary
 java.lang.String getNumHandsWon()
          Return number of hands won.
 java.lang.String getOverallScore()
          Return overall score.
 java.lang.String getTableName()
          Return name of table.
 java.lang.String getTableType()
          Return type of table.
 java.lang.String getUser()
          Return user for whom stats are gathered.
static java.lang.String noSuchTable(java.lang.String tableName)
          Generate error when trying to resolve GameOverCommand for non-existent table.
 void setNumHandsWon(java.lang.String newNumHandsWon)
          Set number of hands won.
 void setOverallScore(java.lang.String newScore)
          Set overall score.
 void setTableName(java.lang.String newTableName)
          Set table name.
 void setTableType(java.lang.String newTableType)
          Set table type.
 void setUser(java.lang.String u)
          Set user for whom stats are gathered.
 
Methods inherited from class ks.common.command.Command
formatString, isError, isQuittable, setQuittable, toString
 
Methods inherited from class ks.common.ArgumentList
addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, clearArg, clearArg, clearArgMulti, clearArgMulti, getArg, getArg, getArgMulti, getArgMulti, multiArgs, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, setArg, setArg, singleArgs
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NUMHANDSWON

public static final java.lang.String NUMHANDSWON
argument for number of hands won.

See Also:
Constant Field Values

OVERALLSCORE

public static final java.lang.String OVERALLSCORE
argument for overall score.

See Also:
Constant Field Values

USER

public static final java.lang.String USER
argument for user.

See Also:
Constant Field Values

TABLETYPE

public static final java.lang.String TABLETYPE
argument for type of solitaire game.

See Also:
Constant Field Values

TABLENAME

public static final java.lang.String TABLENAME
argument for name of solitaire game.

See Also:
Constant Field Values
Constructor Detail

GameOverCommand

public GameOverCommand()
Default Constructor for GameOverCommand.

Method Detail

getTableName

public java.lang.String getTableName()
Return name of table.

Returns:
String

getOverallScore

public java.lang.String getOverallScore()
Return overall score.

Returns:
String

getNumHandsWon

public java.lang.String getNumHandsWon()
Return number of hands won.

Returns:
String

getUser

public java.lang.String getUser()
Return user for whom stats are gathered.

Returns:
String

getTableType

public java.lang.String getTableType()
Return type of table.

Returns:
String

setNumHandsWon

public void setNumHandsWon(java.lang.String newNumHandsWon)
Set number of hands won.

Parameters:
newNumHandsWon - String

setOverallScore

public void setOverallScore(java.lang.String newScore)
Set overall score.

Parameters:
newScore - String

setTableName

public void setTableName(java.lang.String newTableName)
Set table name.

Parameters:
newTableName - String

setUser

public void setUser(java.lang.String u)
Set user for whom stats are gathered.

Returns:
String

setTableType

public void setTableType(java.lang.String newTableType)
Set table type.

Parameters:
newTableType - String

noSuchTable

public static final java.lang.String noSuchTable(java.lang.String tableName)
Generate error when trying to resolve GameOverCommand for non-existent table.