com.oanda.fxtrade.api
Interface FXHistoryPoint

All Superinterfaces:

java.lang.Cloneable

public interface FXHistoryPoint
extends java.lang.Cloneable

A useful container class that holds FXTick objects representing the opening, closing, minimum and maximum bid and ask prices. Also contains the number of ticks within the period.

See Also:

FXTick

Method Summary

java.lang.Object	clone()
CandlePoint	getCandlePoint() Returns the associated CandlePoint for this FXHistoryPoint.
FXTick	getClose() Returns the FXTick containing the closing bid and ask price for this FXHistoryPoint.
boolean	getCorrected() A flag to indicate whether the FXHistoryPoint has been corrected in the vector context that it is part of.
FXTick	getMax() Returns the FXTick containing the maximum bid and ask price for this FXHistoryPoint.
FXTick	getMin() Returns the FXTick containing the minimum bid and ask price for this FXHistoryPoint.
MinMaxPoint	getMinMaxPoint() Returns the associated MinMaxPoint for this FXHistoryPoint.
FXTick	getOpen() Returns the FXTick containing the opening bid and ask price for this FXHistoryPoint.
long	getTimestamp() Returns the opening timestamp for this FXHistoryPoint.
long	getVolume() Returns the volume for this FXHistoryPoint.
void	setCorrected(boolean aCorrected) Set the corrected flag for this FXHistoryPoint
java.lang.String	toString() Returns a String representation of this FXHistoryPoint as follows: timestamp max_bid max_ask open_bid open_ask close_bid close_ask min_bid min_ask volume

Method Detail

clone

java.lang.Object clone()

getCandlePoint

CandlePoint getCandlePoint()

Returns the associated CandlePoint for this FXHistoryPoint.

getClose

FXTick getClose()

Returns the FXTick containing the closing bid and ask price for this FXHistoryPoint.

getCorrected

boolean getCorrected()

A flag to indicate whether the FXHistoryPoint has been corrected in the vector context that it is part of. Re-correction is supposed to be harmless.

Returns:

corrected flag

getMax

FXTick getMax()

Returns the FXTick containing the maximum bid and ask price for this FXHistoryPoint.

getMin

FXTick getMin()

Returns the FXTick containing the minimum bid and ask price for this FXHistoryPoint.

getMinMaxPoint

MinMaxPoint getMinMaxPoint()

Returns the associated MinMaxPoint for this FXHistoryPoint.

getOpen

FXTick getOpen()

Returns the FXTick containing the opening bid and ask price for this FXHistoryPoint.

getTimestamp

long getTimestamp()

Returns the opening timestamp for this FXHistoryPoint.

getVolume

long getVolume()

Returns the volume for this FXHistoryPoint.

setCorrected

void setCorrected(boolean aCorrected)

Set the corrected flag for this FXHistoryPoint

Parameters:

aCorrected - (new value)

toString

java.lang.String toString()

Returns a String representation of this FXHistoryPoint as follows:
timestamp max_bid max_ask open_bid open_ask close_bid close_ask min_bid min_ask volume

Overrides:

toString in class java.lang.Object