Package com.caplin.charting

Class RequestCriteria

java.lang.Object

com.caplin.charting.RequestCriteria

public class RequestCriteria
extends Object

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

Constructor Summary

Constructors

Constructor	Description
RequestCriteria(String instrument, String interval, Date start, Date end, boolean cached)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

RequestCriteria

public RequestCriteria(String instrument,
 String interval,
 Date start,
 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 Details

getInterval

public String getInterval()

Returns:

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

getStart

public Date getStart()

Returns:

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

getEnd

public Date getEnd()

Returns:

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

getInstrument

public 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 String toString()

Overrides:

toString in class Object