rails.game.action
Class BuyCertificate

java.lang.Object
  rails.game.action.PossibleAction
      rails.game.action.BuyCertificate

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

StartCompany

public class BuyCertificate
extends PossibleAction

Author:

Erik Vos

See Also:

Serialized Form

Field Summary

protected PublicCertificateI	certificate
protected java.lang.String	certUniqueId
protected PublicCompanyI	company
protected java.lang.String	companyName
protected Portfolio	from
protected java.lang.String	fromName
protected int	maximumNumber
protected int	numberBought
protected int	price
static long	serialVersionUID
protected int	sharePerCert

Fields inherited from class rails.game.action.PossibleAction

acted, gameManager, log, playerIndex, playerName

Constructor Summary

BuyCertificate()
Required for deserialization

BuyCertificate(PublicCompanyI company, int sharePerCert, Portfolio from, int price)
Buy a certificate from some portfolio at a given price

BuyCertificate(PublicCompanyI company, int sharePerCert, Portfolio from, int price, int maximumNumber)

Method Summary

boolean	equalsAsAction(PossibleAction action) Compare the chosen actions of two action objects.
boolean	equalsAsOption(PossibleAction action) Compare the choice options of two action objects, without regard to whatever choice has been made, if any.
PublicCompanyI	getCompany()
java.lang.String	getCompanyName()
Portfolio	getFromPortfolio()
int	getMaximumNumber()
int	getNumberBought()
int	getPrice()
int	getSharePerCertificate()
int	getSharesPerCertificate()
void	setNumberBought(int numberBought)
java.lang.String	toString()

Methods inherited from class rails.game.action.PossibleAction

getCompanyManager, getGameManager, getPlayerIndex, getPlayerName, hasActed, setActed, setPlayerName, toMenu

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

certificate

protected transient PublicCertificateI certificate

certUniqueId

protected java.lang.String certUniqueId

company

protected transient PublicCompanyI company

companyName

protected java.lang.String companyName

sharePerCert

protected int sharePerCert

from

protected transient Portfolio from

fromName

protected java.lang.String fromName

price

protected int price

maximumNumber

protected int maximumNumber

numberBought

protected int numberBought

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

BuyCertificate

public BuyCertificate(PublicCompanyI company,
                      int sharePerCert,
                      Portfolio from,
                      int price,
                      int maximumNumber)

BuyCertificate

public BuyCertificate(PublicCompanyI company,
                      int sharePerCert,
                      Portfolio from,
                      int price)

Buy a certificate from some portfolio at a given price

BuyCertificate

public BuyCertificate()

Required for deserialization

Method Detail

getFromPortfolio

public Portfolio getFromPortfolio()

getMaximumNumber

public int getMaximumNumber()

Returns:

Returns the maximumNumber.

getPrice

public int getPrice()

Returns:

Returns the price.

getCompany

public PublicCompanyI getCompany()

getCompanyName

public java.lang.String getCompanyName()

getSharePerCertificate

public int getSharePerCertificate()

getSharesPerCertificate

public int getSharesPerCertificate()

getNumberBought

public int getNumberBought()

setNumberBought

public void setNumberBought(int numberBought)

equalsAsOption

public boolean equalsAsOption(PossibleAction action)

Description copied from class: PossibleAction

Compare the choice options of two action objects, without regard to whatever choice has been made, if any. In other words: only the server-set (prior) attributes must be compared.

This method is used by the server (engine) to validate the incoming action that has actually been chosen in the client (GUI), but only for the purpose to check if the chosen option was really on offer, not to check if the chosen action is actually valid. These perspectives could give different results in cases where the PossibleAction does not fully restrict choices to valid values only (such as the blanket LayTile that does no restrict the hex to lay a tile on, or the SetDividend that will accept any revenue value).

Specified by:

equalsAsOption in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal choice options.

equalsAsAction

public boolean equalsAsAction(PossibleAction action)

Description copied from class: PossibleAction

Compare the chosen actions of two action objects. In other words: the client-set (posterior) attributes must be compared, in addition to those server-set (prior) attributes that sufficiently identify the action.

This method is used by the server (engine) to check if two action objects represent the same actual action, as is done when reloading a saved file (i.e. loading a later stage of the same game).

Specified by:

equalsAsAction in class PossibleAction

Parameters:

action - Another PossibleAction to compare with.

Returns:

True if the compared PossibleAction object has equal selected action values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object