public interface

TimeAwareLayer

com.esri.core.map.TimeAwareLayer
Known Indirect Subclasses

Class Overview

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

Summary

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

Public Methods

public abstract TimeExtent getTimeExtent ()

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

Returns
TimeExtent the valid range of dates for this layer.

public abstract TimeInfo getTimeInfo ()

Get all the time awareness information for this layer.

Returns
TimeInfo the time awareness information as a TimeInfo object

public abstract TimeExtent getTimeInterval ()

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

Returns
TimeExtent the current date/time range

public abstract boolean isTimeAware ()

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

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

public abstract void setTimeInterval (TimeExtent timeExtent)

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

Parameters
timeExtent TimeExtent: the new date/time range