com.esri.core.map
Interface TimeAwareLayer

public interface TimeAwareLayer

This interface should be implemented by any layer that can be filtered by date/time (time aware). It is used by JMap to determine that a given layer is time aware and can have date/time ranges applied to filter its data.

Since:

10.1.1

Method Summary

TimeExtent	getTimeExtent() Gets the valid TimeExtent object for the Layer or null if this service does not support time based queries.
TimeInfo	getTimeInfo() Get all the time awareness information for this layer.
TimeExtent	getTimeInterval() Get the current date/time range that this layer is filtered by.
boolean	isTimeAware() Indicates whether or not this particular layer instance is time aware.
void	setTimeInterval(TimeExtent timeExtent) Set the current date/time range that this layer will be filtered by.

Method Detail

isTimeAware

boolean isTimeAware()

Indicates whether or not this particular layer instance is time aware.

Returns:

True if this is a time aware layer, false otherwise.

Since:

10.1.1

getTimeExtent

TimeExtent getTimeExtent()

Gets the valid TimeExtent object for the Layer or null if this service does not support time based queries.

Returns:

the valid range of dates for this layer.

Since:

10.1.1

getTimeInterval

TimeExtent getTimeInterval()

Get the current date/time range that this layer is filtered by.

Returns:

the current date/time range

Since:

10.1.1

setTimeInterval

void setTimeInterval(TimeExtent timeExtent)

Set the current date/time range that this layer will be filtered by.

Parameters:

timeExtent - the new date/time range

Since:

10.1.1

getTimeInfo

TimeInfo getTimeInfo()

Get all the time awareness information for this layer.

Returns:

Since:

10.1.1