rails.game
Interface CompanyManagerI

All Superinterfaces:

ConfigurableComponentI

All Known Implementing Classes:

CompanyManager

public interface CompanyManagerI
extends ConfigurableComponentI

Interface for CompanyManager objects. A company manager is a factory which vends Company objects.

Field Summary

static java.lang.String

COMPONENT_NAME This is the name by which the CompanyManager should be registered with the ComponentManager.

Method Summary

java.lang.String	checkAlias(java.lang.String alias)
java.lang.String	checkAliasInCertId(java.lang.String certId)
void	closeAllPrivates()
java.util.List<PrivateCompanyI>	getAllPrivateCompanies() Gives a list of all the registered Private Companies.
java.util.List<PublicCompanyI>	getAllPublicCompanies() Gives a list of all the registered Private Companies.
CompanyI	getCompany(java.lang.String type, java.lang.String name) Find a company by type and name
java.util.List<CompanyTypeI>	getCompanyTypes()
PrivateCompanyI	getPrivateCompany(java.lang.String name) Returns the Private Company identified by the supplied name.
java.util.List<PrivateCompanyI>	getPrivatesOwnedByPlayers()
PublicCompanyI	getPublicCompany(java.lang.String name) Returns the Public Company identified by the supplied name.
StartPacket	getStartPacket(int index)
StartPacket	getStartPacket(java.lang.String name)

Methods inherited from interface rails.game.ConfigurableComponentI

configureFromXML, finishConfiguration

Field Detail

COMPONENT_NAME

static final java.lang.String COMPONENT_NAME

This is the name by which the CompanyManager should be registered with the ComponentManager.

See Also:

Constant Field Values

Method Detail

getPrivateCompany

PrivateCompanyI getPrivateCompany(java.lang.String name)

Returns the Private Company identified by the supplied name.

Parameters:

name - the name of the company sought

Returns:

the Private Company with the supplied name

getPublicCompany

PublicCompanyI getPublicCompany(java.lang.String name)

Returns the Public Company identified by the supplied name.

Parameters:

name - the name of the company sought

Returns:

the Public Company with the supplied name

getAllPrivateCompanies

java.util.List<PrivateCompanyI> getAllPrivateCompanies()

Gives a list of all the registered Private Companies.

Returns:

a list of all the registered Private Companies

getAllPublicCompanies

java.util.List<PublicCompanyI> getAllPublicCompanies()

Gives a list of all the registered Private Companies.

Returns:

a list of all the registered Private Companies

getCompany

CompanyI getCompany(java.lang.String type,
                    java.lang.String name)

Find a company by type and name

Parameters:

type - The name of the CompanyType

name - The name of the Company

Returns:

The company object, or null if not found.

checkAlias

java.lang.String checkAlias(java.lang.String alias)

checkAliasInCertId

java.lang.String checkAliasInCertId(java.lang.String certId)

getCompanyTypes

java.util.List<CompanyTypeI> getCompanyTypes()

closeAllPrivates

void closeAllPrivates()

getPrivatesOwnedByPlayers

java.util.List<PrivateCompanyI> getPrivatesOwnedByPlayers()

getStartPacket

StartPacket getStartPacket(int index)

getStartPacket

StartPacket getStartPacket(java.lang.String name)