com.lmax.api.orderbook
Interface CalendarInfo


public interface CalendarInfo

Contains all of the information relating to dates and times during which the instrument is tradeable.


Method Summary
 int getClose()
          Get the time of day that the market will close (in time zone specified) by this object.
 java.util.Date getExpiryTime()
          Get the Date the instrument will expire, mostly relevant for instruments like futures that only exist for a limited time.
 int getOpen()
          Get the time of day that the market will open (in time zone specified) by this object.
 java.util.Date getStartTime()
          Get the start time of the instrument, this is the time that the instrument will first be available to trade.
 java.lang.String getTimeZone()
          Get the timezone in which this calendar operates.
 java.util.List<DayOfWeek> getTradingDays()
          Get the days of week that the market is open.
 

Method Detail

getStartTime

java.util.Date getStartTime()
Get the start time of the instrument, this is the time that the instrument will first be available to trade.

Returns:
the start date.

getExpiryTime

java.util.Date getExpiryTime()
Get the Date the instrument will expire, mostly relevant for instruments like futures that only exist for a limited time.

Returns:
the date the instrument will expiry.

getOpen

int getOpen()
Get the time of day that the market will open (in time zone specified) by this object.

Returns:
offset from midnight in minutes.

getClose

int getClose()
Get the time of day that the market will close (in time zone specified) by this object.

Returns:
offset from midnight in minutes.

getTimeZone

java.lang.String getTimeZone()
Get the timezone in which this calendar operates.

Returns:
time zone.

getTradingDays

java.util.List<DayOfWeek> getTradingDays()
Get the days of week that the market is open.

Returns:
days of week the instrument is open.