com.caplin.charting

Interface ChartDataRequest

public interface ChartDataRequest

A ChartDataRequest contains the parameters of a request (the request criteria) and methods to respond to the request with data or an error.

Method Summary

Methods

Modifier and Type	Method and Description
RequestCriteria	getRequestCriteria() Call this method to retrieve the RequestCriteria for the current request.
void	sendDataResponse(java.lang.String seriesName, java.util.List<OhlcvData> ohlcvData) When data has been retrieved by a ChartDataProvider for a request, it should call sendDataResponse with the retrieved data.
void	sendErrorResponse() If a ChartDataProvider determines that this request is not valid then it should call sendErrorResponse.

Method Detail

sendDataResponse

void sendDataResponse(java.lang.String seriesName,
                    java.util.List<OhlcvData> ohlcvData)

When data has been retrieved by a ChartDataProvider for a request, it should call sendDataResponse with the retrieved data.

Parameters:

seriesName - the name of the data series.

ohlcvData - a list of OhlcvData objects representing all the data that was requested. May not be null.

sendErrorResponse

void sendErrorResponse()

If a ChartDataProvider determines that this request is not valid then it should call sendErrorResponse.

getRequestCriteria

RequestCriteria getRequestCriteria()

Call this method to retrieve the RequestCriteria for the current request.

Returns:

The criteria indicating which data has been requested. Will not be null.