rails.game
Interface CompanyI

All Superinterfaces:

ConfigurableComponentI, MoveableHolder

All Known Subinterfaces:

PrivateCompanyI, PublicCompanyI

All Known Implementing Classes:

Company, Investor_1880, PrivateCompany, PublicCompany, PublicCompany_1825, PublicCompany_1856, PublicCompany_1880, PublicCompany_CGR

public interface CompanyI
extends ConfigurableComponentI, MoveableHolder

To be implemented by any Company object.

Field Summary

static java.lang.String	COMPANY_ELEMENT_ID The name of the XML tag used to configure a company.
static java.lang.String	COMPANY_NAME_TAG The name of the XML attribute for the company's name.
static java.lang.String	COMPANY_TYPE_TAG The name of the XML attribute for the company's type.

Method Summary

java.lang.Object	clone()
boolean	equals(CompanyI company)
java.lang.String	getAlias()
int	getCertLimitCount()
int	getCompanyNumber()
java.lang.String	getInfoText()
java.lang.String	getLongName()
java.lang.String	getName() Returns the name of the Company
Portfolio	getPortfolio() Get the Portfolio of this company, containing all privates and certificates owned..
java.util.List<SpecialPropertyI>	getSpecialProperties()
CompanyTypeI	getType() Returns the CompanyType of the Company
java.lang.String	getTypeName() Returns the type name of the Company
int	getValue()
boolean	hasSpecialProperties() Do we have any special properties?
void	init(java.lang.String name, CompanyTypeI type)
boolean	isClosed()
void	setCertLimitCount(int i)
void	setClosed() Set company to closed
void	setValue(int i)
java.lang.String	toString()

Methods inherited from interface rails.game.ConfigurableComponentI

configureFromXML, finishConfiguration

Methods inherited from interface rails.game.move.MoveableHolder

addObject, getListIndex, removeObject

Field Detail

COMPANY_ELEMENT_ID

static final java.lang.String COMPANY_ELEMENT_ID

The name of the XML tag used to configure a company.

See Also:

Constant Field Values

COMPANY_NAME_TAG

static final java.lang.String COMPANY_NAME_TAG

The name of the XML attribute for the company's name.

See Also:

Constant Field Values

COMPANY_TYPE_TAG

static final java.lang.String COMPANY_TYPE_TAG

The name of the XML attribute for the company's type.

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String name,
          CompanyTypeI type)

getSpecialProperties

java.util.List<SpecialPropertyI> getSpecialProperties()

Returns:

ArrayList of all special properties we have.

hasSpecialProperties

boolean hasSpecialProperties()

Do we have any special properties?

Returns:

Boolean

getPortfolio

Portfolio getPortfolio()

Get the Portfolio of this company, containing all privates and certificates owned..

Returns:

The Portfolio of this company.

getName

java.lang.String getName()

Returns the name of the Company

Specified by:

getName in interface MoveableHolder

Returns:

the name of the Company

getLongName

java.lang.String getLongName()

getInfoText

java.lang.String getInfoText()

getAlias

java.lang.String getAlias()

getType

CompanyTypeI getType()

Returns the CompanyType of the Company

Returns:

the type of the Company

getTypeName

java.lang.String getTypeName()

Returns the type name of the Company

Returns:

type name

getValue

int getValue()

Returns:

Company Value

setValue

void setValue(int i)

Parameters:

Company - Value

getCompanyNumber

int getCompanyNumber()

Returns:

Company number

isClosed

boolean isClosed()

Returns:

true if Company is closed.

setClosed

void setClosed()

Set company to closed

getCertLimitCount

int getCertLimitCount()

Returns:

setCertLimitCount

void setCertLimitCount(int i)

Parameters:

i -

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

boolean equals(CompanyI company)