plham

Class Order

plham.Order

Direct Known Subclasses:

Cancel

public class Order

A data structure for orders.

Specify

• Type (kind): {buy, sell} x {limit, market}
• Price
• Volume
• Expiry time (relative)

Field Summary

Fields

Modifier and Type	Field and Description
static plham.Order.Kind	KIND_BUY_LIMIT_ORDER Field Type: plham.Order.Kind{self.id==3L}
static plham.Order.Kind	KIND_BUY_MARKET_ORDER Field Type: plham.Order.Kind{self.id==1L}
static plham.Order.Kind	KIND_SELL_LIMIT_ORDER Field Type: plham.Order.Kind{self.id==4L}
static plham.Order.Kind	KIND_SELL_MARKET_ORDER Field Type: plham.Order.Kind{self.id==2L}
static Double	NO_PRICE Field Type: Double{self==Double.MAX_VALUE} Use if a market order
Long	agentId
plham.Order.Kind	kind
Long	marketId
Long	orderId The order id used for consulting and to notify its execution (set to 0 if unnecessary; this is by default).
Double	price
Long	timeLength The relative term until the expiry time (due time).
Long	timePlaced The time when this order is placed.
Long	volume

Constructor Summary

Constructors

Constructor and Description
Order(plham.Order.Kind kind, Long agentId, Long marketId, Double price, Long volume, Long timeLength, Long timePlaced, Long orderId) Do not use this.
Order(plham.Order.Kind kind, Long agentId, Long marketId, Double price, Long volume, Long timeLength, Long timePlaced) Do not use this.
Order(plham.Order.Kind kind, Agent agent, Market market, Double price, Long volume, Long timeLength)
Order(Order other) Create a copy.

Method Summary

Modifier and Type	Method and Description
String	getKindName()
Double	getPrice()
Long	getVolume()
Boolean	isBuyOrder()
Boolean	isCancel() Test if this is a cancel request for an order.
Boolean	isExpired(Market market) Test if this order has been expired.
Boolean	isExpired(Long t) Test if this order has been expired.
Boolean	isLimitOrder()
Boolean	isMarketOrder()
Boolean	isSellOrder()
Double	setPrice(Double price)
Long	setVolume(Long volume)
String	toString()
void	updateVolume(Long delta) Update the volume of this order by adding delta.

Field Detail

KIND_BUY_MARKET_ORDER

public static final plham.Order.Kind KIND_BUY_MARKET_ORDER

Field Type: plham.Order.Kind{self.id==1L}

KIND_SELL_MARKET_ORDER

public static final plham.Order.Kind KIND_SELL_MARKET_ORDER

Field Type: plham.Order.Kind{self.id==2L}

KIND_BUY_LIMIT_ORDER

public static final plham.Order.Kind KIND_BUY_LIMIT_ORDER

Field Type: plham.Order.Kind{self.id==3L}

KIND_SELL_LIMIT_ORDER

public static final plham.Order.Kind KIND_SELL_LIMIT_ORDER

Field Type: plham.Order.Kind{self.id==4L}

NO_PRICE

public static final Double NO_PRICE

Field Type: Double{self==Double.MAX_VALUE}

Use if a market order

kind

public plham.Order.Kind kind

agentId

public Long agentId

marketId

public Long marketId

price

public Double price

volume

public Long volume

timeLength

public Long timeLength

The relative term until the expiry time (due time).

timePlaced

public Long timePlaced

The time when this order is placed. I.e. market.getTime().

orderId

public Long orderId

The order id used for consulting and to notify its execution (set to 0 if unnecessary; this is by default).

Constructor Detail

Order

public Order(plham.Order.Kind kind,
             Long agentId,
             Long marketId,
             Double price,
             Long volume,
             Long timeLength,
             Long timePlaced,
             Long orderId)

Do not use this.

Order

public Order(plham.Order.Kind kind,
             Long agentId,
             Long marketId,
             Double price,
             Long volume,
             Long timeLength,
             Long timePlaced)

Do not use this.

Order

public Order(plham.Order.Kind kind,
             Agent agent,
             Market market,
             Double price,
             Long volume,
             Long timeLength)

Order

public Order(Order other)

Create a copy.

Method Detail

getPrice

public Double getPrice()

setPrice

public Double setPrice(Double price)

getVolume

public Long getVolume()

setVolume

public Long setVolume(Long volume)

updateVolume

public void updateVolume(Long delta)

Update the volume of this order by adding delta.

isBuyOrder

public Boolean isBuyOrder()

isSellOrder

public Boolean isSellOrder()

isLimitOrder

public Boolean isLimitOrder()

isMarketOrder

public Boolean isMarketOrder()

isCancel

public Boolean isCancel()

Test if this is a cancel request for an order.

Returns:

true if instanceof Cancel

isExpired

public Boolean isExpired(Market market)

Test if this order has been expired.

Parameters:

market -

Returns:

true if expired

isExpired

public Boolean isExpired(Long t)

Test if this order has been expired.

Parameters:

t -

Returns:

true if expired

toString

public String toString()

getKindName

public String getKindName()