com.esri.arcgis.system
Interface ITimeReference

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeReference

public interface ITimeReference
extends Serializable

Provides access to members that control the Time Reference.

Description

The ITimeReference interface provides analogous functionality to the spatial reference. It provides a context for the scalar value contained in ITimeValue. It stores all of the time zone information and all of the daylight savings time information related to a system of time. Note that the TimeZoneInfo can contain several years worth of rules, which are different from one year to the next.

Product Availability

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

Method Summary

ITimeZoneInfo	getTimeZoneInfo() The time zone information associated with the time reference.
boolean	isRespectsDaylightSavingTime() Indicates whether the time reference respects daylight saving time.
boolean	isRespectsDynamicAdjustmentRules() Indicates whether the time reference respects dynamic adjustment rules.
void	project(ITime time, ITimeReference otherTimeReference) Projects a given time, from this time reference, to a given time reference.
void	projectFromUTC(ITime time) Projects a given time, from UTC to this time reference.
void	projectToUTC(ITime time) Projects a given time, from this time reference, to UTC.
void	setRespectsDaylightSavingTime(boolean respectsDaylightSavingTime) Indicates whether the time reference respects daylight saving time.
void	setRespectsDynamicAdjustmentRules(boolean respectsDynamicAdjustmentRules) Indicates whether the time reference respects dynamic adjustment rules.
void	setTimeZoneInfoByRef(ITimeZoneInfo timeZone) The time zone information associated with the time reference.

Method Detail

getTimeZoneInfo

ITimeZoneInfo getTimeZoneInfo()
                              throws IOException,
                                     AutomationException

The time zone information associated with the time reference.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeZoneInfoByRef

void setTimeZoneInfoByRef(ITimeZoneInfo timeZone)
                          throws IOException,
                                 AutomationException

The time zone information associated with the time reference.

Product Availability

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

Parameters:

timeZone - A reference to a com.esri.arcgis.system.ITimeZoneInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRespectsDaylightSavingTime

boolean isRespectsDaylightSavingTime()
                                     throws IOException,
                                            AutomationException

Indicates whether the time reference respects daylight saving time.

Product Availability

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

Returns:

The respectsDaylightSavingTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRespectsDaylightSavingTime

void setRespectsDaylightSavingTime(boolean respectsDaylightSavingTime)
                                   throws IOException,
                                          AutomationException

Indicates whether the time reference respects daylight saving time.

Product Availability

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

Parameters:

respectsDaylightSavingTime - The respectsDaylightSavingTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRespectsDynamicAdjustmentRules

boolean isRespectsDynamicAdjustmentRules()
                                         throws IOException,
                                                AutomationException

Indicates whether the time reference respects dynamic adjustment rules.

Product Availability

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

Returns:

The respectsDynamicAdjustmentRules

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRespectsDynamicAdjustmentRules

void setRespectsDynamicAdjustmentRules(boolean respectsDynamicAdjustmentRules)
                                       throws IOException,
                                              AutomationException

Indicates whether the time reference respects dynamic adjustment rules.

Product Availability

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

Parameters:

respectsDynamicAdjustmentRules - The respectsDynamicAdjustmentRules (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

project

void project(ITime time,
             ITimeReference otherTimeReference)
             throws IOException,
                    AutomationException

Projects a given time, from this time reference, to a given time reference.

Product Availability

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

Parameters:

time - A reference to a com.esri.arcgis.system.ITime (in)

otherTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectToUTC

void projectToUTC(ITime time)
                  throws IOException,
                         AutomationException

Projects a given time, from this time reference, to UTC.

Product Availability

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

Parameters:

time - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectFromUTC

void projectFromUTC(ITime time)
                    throws IOException,
                           AutomationException

Projects a given time, from UTC to this time reference.

Product Availability

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

Parameters:

time - A reference to a com.esri.arcgis.system.ITime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.