net.commerce.zocalo.orders
Class Order

java.lang.Object
  net.commerce.zocalo.orders.Order

All Implemented Interfaces:

java.lang.Comparable

public class Order
extends java.lang.Object
implements java.lang.Comparable

An Order by a User to buy a quantity of an asset at a particular price.

Constructor Summary

Order(Position position, Price price, Quantity quantity, User owner)

Method Summary

Quantity	affordableQuantity(Quantity reservePrice, Quantity quantityDesired)
Quantity	availableCoupons(Position position)
static int	comparePrices(double onePrice, double otherPrice)
static int	compareQuantities(double oneQuantity, double otherQuantity)
int	compareTo(java.lang.Object o)
BestAsk	makeBestAsk()
BestBid	makeBestBid()
OrderRemoval	makeRemovalRecord()
Price	naturalPrice()
Quantity	originalQuantity()
java.lang.String	ownerName()
Position	position()
Price	price()
boolean	priceNotLessThan(Price v)
Coupons	provideCoupons(Position position, Quantity quantity)
Funds	provideFundsForTrade(Quantity quantity, Price price)
Quantity	quantity()
void	receive(Coupons coupons)
void	reduceQuantityDueToSale(Quantity reduction)
void	reduceQuantityDueToUnaffordability(Quantity reduction)
void	releaseReserves(Quantity quantity, Position position)
void	removeFromOwner()
Quantity	requiredReserves(Market market)
void	returnCash(Funds funds)
void	settleOffsettingPositions(Market market) convert balanced pairs (or sets) of coupons in position into cash.
java.lang.String	toString()
boolean	userIsOwner(User user)
void	withholdReserves(ReserveVerifier verifier, Quantity quantity, Position position)

Methods inherited from class java.lang.Object

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

Constructor Detail

Order

public Order(Position position,
             Price price,
             Quantity quantity,
             User owner)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

reduceQuantityDueToSale

public void reduceQuantityDueToSale(Quantity reduction)

reduceQuantityDueToUnaffordability

public void reduceQuantityDueToUnaffordability(Quantity reduction)

quantity

public Quantity quantity()

originalQuantity

public Quantity originalQuantity()

price

public Price price()

position

public Position position()

comparePrices

public static int comparePrices(double onePrice,
                                double otherPrice)

compareQuantities

public static int compareQuantities(double oneQuantity,
                                    double otherQuantity)

provideFundsForTrade

public Funds provideFundsForTrade(Quantity quantity,
                                  Price price)

withholdReserves

public void withholdReserves(ReserveVerifier verifier,
                             Quantity quantity,
                             Position position)

releaseReserves

public void releaseReserves(Quantity quantity,
                            Position position)

receive

public void receive(Coupons coupons)

priceNotLessThan

public boolean priceNotLessThan(Price v)

requiredReserves

public Quantity requiredReserves(Market market)
                          throws ScoreException

Throws:

ScoreException

returnCash

public void returnCash(Funds funds)

userIsOwner

public boolean userIsOwner(User user)

settleOffsettingPositions

public void settleOffsettingPositions(Market market)

convert balanced pairs (or sets) of coupons in position into cash.

naturalPrice

public Price naturalPrice()

ownerName

public java.lang.String ownerName()

removeFromOwner

public void removeFromOwner()

availableCoupons

public Quantity availableCoupons(Position position)

provideCoupons

public Coupons provideCoupons(Position position,
                              Quantity quantity)

affordableQuantity

public Quantity affordableQuantity(Quantity reservePrice,
                                   Quantity quantityDesired)

makeBestBid

public BestBid makeBestBid()

makeBestAsk

public BestAsk makeBestAsk()

makeRemovalRecord

public OrderRemoval makeRemovalRecord()