com.oanda.fxtrade.api
Interface FXRateEventInfo

All Superinterfaces:

FXEventInfo

public interface FXRateEventInfo
extends FXEventInfo

An FXRateEventInfo object encapsulates a new market rate received from the server.

Author:

Chris MacGregor

Method Summary

int	compareTo(java.lang.Object o) Comparable implementation
boolean	equals(java.lang.Object other) Test to see if this object is equal to another object.
FXEventKey	getKey() Accessor method used by the API
FXPair	getPair() Get the currency pair whose rate has changed
FXTick	getTick() Gets the new rate of the pair whose rate has changed
long	getTimestamp() Gets the server timestamp that the data in the event info was generated
int	hashcode() Return the hashcode

Method Detail

getKey

FXEventKey getKey()

Accessor method used by the API

Specified by:

getKey in interface FXEventInfo

Returns:

The FXeventKey

getTimestamp

long getTimestamp()

Gets the server timestamp that the data in the event info was generated

Specified by:

getTimestamp in interface FXEventInfo

Returns:

The server timestamp that the data was generated

getTick

FXTick getTick()

Gets the new rate of the pair whose rate has changed

Returns:

An FXTick containing the pair's new rate

getPair

FXPair getPair()

Get the currency pair whose rate has changed

Returns:

An FXPair representing the pair whose rate has changed

equals

boolean equals(java.lang.Object other)

Test to see if this object is equal to another object.

Overrides:

equals in class java.lang.Object

hashcode

int hashcode()

Return the hashcode

Returns:

the hashcode of this pair

compareTo

int compareTo(java.lang.Object o)

Comparable implementation

Specified by:

compareTo in interface FXEventInfo