com.caplin.charting

Class RequestCriteria

java.lang.Object

com.caplin.charting.RequestCriteria

public class RequestCriteria
extends java.lang.Object

A RequestCriteria holds all the parameters that are part of a request for historic chart data.

Constructor Summary

Constructors

Constructor and Description
RequestCriteria(java.lang.String instrument, java.lang.String interval, java.util.Date start, java.util.Date end, boolean cached)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getEnd()
java.lang.String	getInstrument()
java.lang.String	getInterval()
java.util.Date	getStart()
boolean	isCached()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestCriteria

public RequestCriteria(java.lang.String instrument,
               java.lang.String interval,
               java.util.Date start,
               java.util.Date end,
               boolean cached)

Parameters:

instrument - the instrument that this data is about. May not be null.

interval - the intervalisation of the data. For example "1h" for datapoints covering an hour each.

start - the earliest time which is being requested. May be null.

end - the latest time which is being requested. May be null.

cached - whether or not the request is for cached data or live data.

Method Detail

getInterval

public java.lang.String getInterval()

Returns:

the intervalisation of the data. For example "1h" for datapoints covering an hour each.

getStart

public java.util.Date getStart()

Returns:

the earliest time which is being requested. May be null.

getEnd

public java.util.Date getEnd()

Returns:

the latest time which is being requested. May be null.

getInstrument

public java.lang.String getInstrument()

Returns:

the instrument that this data is about. May not be null.

isCached

public boolean isCached()

Returns:

true if this request is for cached data, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object