com.esri.arcgis.carto
Interface IMapServerTimeInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerInfo

public interface IMapServerTimeInfo
extends Serializable

Provides access to core objects contained within the map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

double	getDefaultTimeInterval() The recommended default time interval to be used to animate the layer/table in the service.
int	getDefaultTimeIntervalUnits() The recommended default time interval units to be used to animate the layer/table in the service.
double	getDefaultTimeWindow() The recommended time window expressed in the same units as the time interval for the service.
ITimeExtent	getFullTimeExtent() TimeExtent of interest that the map as been authored.

Method Detail

getFullTimeExtent

ITimeExtent getFullTimeExtent()
                              throws IOException,
                                     AutomationException

TimeExtent of interest that the map as been authored.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.ITimeExtent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeInterval

double getDefaultTimeInterval()
                              throws IOException,
                                     AutomationException

The recommended default time interval to be used to animate the layer/table in the service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeIntervalUnits

int getDefaultTimeIntervalUnits()
                                throws IOException,
                                       AutomationException

The recommended default time interval units to be used to animate the layer/table in the service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTimeWindow

double getDefaultTimeWindow()
                            throws IOException,
                                   AutomationException

The recommended time window expressed in the same units as the time interval for the service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The duration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.