org.marketcetera.client.brokers

Class BrokerStatus

java.lang.Object

org.marketcetera.client.brokers.BrokerStatus

All Implemented Interfaces:

Serializable

public class BrokerStatus
extends Object
implements Serializable

The web service representation of a single broker's status.

Since:

1.0.0

Version:

$Id: BrokerStatus.java 16752 2013-11-14 02:54:13Z colin $

Author:

tlerios@marketcetera.com

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BrokerStatus() Creates a new status representation.
	BrokerStatus(String inName, BrokerID inId, boolean inLoggedOn) Create a new BrokerStatus instance.
	BrokerStatus(String name, BrokerID id, boolean loggedOn, Set<BrokerAlgoSpec> inAlgoSpecs) Creates a new status representation, given the broker information.

Method Summary

Methods

Modifier and Type	Method and Description
Set<BrokerAlgoSpec>	getBrokerAlgos() Get the brokerAlgos value.
BrokerID	getId() Returns the receiver's broker ID.
boolean	getLoggedOn() Returns the receiver's logon flag.
String	getName() Returns the receiver's name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerStatus

public BrokerStatus(String name,
            BrokerID id,
            boolean loggedOn,
            Set<BrokerAlgoSpec> inAlgoSpecs)

Creates a new status representation, given the broker information.

Parameters:

name - The broker name.

id - The broker ID.

loggedOn - The logon flag.

inAlgoSpecs - a Set<BrokerAlgoSpec> value

BrokerStatus

public BrokerStatus(String inName,
            BrokerID inId,
            boolean inLoggedOn)

Create a new BrokerStatus instance.

Parameters:

inName - a String value

inId - a BrokerID value

inLoggedOn - a boolean value

BrokerStatus

protected BrokerStatus()

Creates a new status representation. This empty constructor is intended for use by JAXB.

Method Detail

getName

public String getName()

Returns the receiver's name.

Returns:

The name.

getId

public BrokerID getId()

Returns the receiver's broker ID.

Returns:

The ID.

getLoggedOn

public boolean getLoggedOn()

Returns the receiver's logon flag.

Returns:

The flag.

getBrokerAlgos

public Set<BrokerAlgoSpec> getBrokerAlgos()

Get the brokerAlgos value.

Returns:

a Set<BrokerAlgoSpec> value

toString

public String toString()

Overrides:

toString in class Object