com.xeiam.xchange.dto.trade

Class FloatingRateLoanOrder

java.lang.Object

com.xeiam.xchange.dto.LoanOrder

com.xeiam.xchange.dto.trade.FloatingRateLoanOrder

All Implemented Interfaces:

Comparable<FloatingRateLoanOrder>

public final class FloatingRateLoanOrder
extends LoanOrder
implements Comparable<FloatingRateLoanOrder>

DTO representing a floating rate loan order

A floating rate loan order is a loan order whose rate is determined by the market. This type of loan order can be preferable for creditors when loans have a callable provision (i.e. the debtor can choose to pay off the loan early and acquire another loan at a more favorable rate).

Constructor Summary

Constructors

Constructor and Description
FloatingRateLoanOrder(Order.OrderType type, String currency, BigDecimal tradableAmount, int dayPeriod, String id, Date timestamp, BigDecimal rate)

Method Summary

Modifier and Type	Method and Description
int	compareTo(FloatingRateLoanOrder order)
BigDecimal	getRate()
void	setRate(BigDecimal rate)

Methods inherited from class com.xeiam.xchange.dto.LoanOrder

equals, getCurrency, getDayPeriod, getId, getTimestamp, getTradableAmount, getType, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatingRateLoanOrder

public FloatingRateLoanOrder(Order.OrderType type,
                             String currency,
                             BigDecimal tradableAmount,
                             int dayPeriod,
                             String id,
                             Date timestamp,
                             BigDecimal rate)

Parameters:

type - Either BID (debtor) or ASK (creditor)

currency - The loan currency code

tradableAmount - Units of currency

dayPeriod - Loan duration in days

id - An id (usually provided by the exchange)

timestamp - The absolute time for this order

Method Detail

getRate

public BigDecimal getRate()

setRate

public void setRate(BigDecimal rate)

compareTo

public int compareTo(FloatingRateLoanOrder order)

Specified by:

compareTo in interface Comparable<FloatingRateLoanOrder>