com.esri.arcgis.system
Interface ITimeZoneRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeZoneRule

public interface ITimeZoneRule
extends Serializable

Provides access to members that control the Time Zone Rule.

Description

ITimeZoneRule provides the detailed time zone and daylight savings time rules for a specific year. It includes the time difference between this time zone and UTC, the amount of shift during daylight savings time, the start date of daylight savings time, and the end date of daylight savings time.

Product Availability

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

Method Summary

int	getBiasFromUTC() The time zone bias from UTC in minutes.
int	getDaylightTimeBias() The bias to be used during daylight time.
_TimeZoneTransitionTime	getDaylightTimeTransitionTime() Date for transition to daylight time.
int	getStandardTimeBias() The bias to be used during Standard time.
_TimeZoneTransitionTime	getStandardTimeTransitionTime() Date for transition to standard time.
int	getYear() The year this rule is in effect.
void	setBiasFromUTC(int biasFromUTC) The time zone bias from UTC in minutes.
void	setDaylightTimeBias(int daylightTimeBias) The bias to be used during daylight time.
void	setDaylightTimeTransitionTime(_TimeZoneTransitionTime daylightTimeTransitionTime) Date for transition to daylight time.
void	setStandardTimeBias(int standardTimeBias) The bias to be used during Standard time.
void	setStandardTimeTransitionTime(_TimeZoneTransitionTime standardTimeTransitionTime) Date for transition to standard time.
void	setYear(int year) The year this rule is in effect.

Method Detail

getYear

int getYear()
            throws IOException,
                   AutomationException

The year this rule is in effect.

Product Availability

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

Returns:

The year

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYear

void setYear(int year)
             throws IOException,
                    AutomationException

The year this rule is in effect.

Product Availability

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

Parameters:

year - The year (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBiasFromUTC

int getBiasFromUTC()
                   throws IOException,
                          AutomationException

The time zone bias from UTC in minutes. LocalTime = UtcTime + BiasFromUTC.

Product Availability

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

Returns:

The biasFromUTC

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBiasFromUTC

void setBiasFromUTC(int biasFromUTC)
                    throws IOException,
                           AutomationException

The time zone bias from UTC in minutes. LocalTime = UtcTime + BiasFromUTC.

Product Availability

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

Parameters:

biasFromUTC - The biasFromUTC (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeTransitionTime

_TimeZoneTransitionTime getDaylightTimeTransitionTime()
                                                      throws IOException,
                                                             AutomationException

Date for transition to daylight time.

Product Availability

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

Returns:

A Structure: com.esri.arcgis.system._TimeZoneTransitionTime (A com.esri.arcgis.system._TimeZoneTransitionTime COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeTransitionTime

void setDaylightTimeTransitionTime(_TimeZoneTransitionTime daylightTimeTransitionTime)
                                   throws IOException,
                                          AutomationException

Date for transition to daylight time.

Product Availability

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

Parameters:

daylightTimeTransitionTime - A Structure: com.esri.arcgis.system._TimeZoneTransitionTime (A com.esri.arcgis.system._TimeZoneTransitionTime COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeBias

int getDaylightTimeBias()
                        throws IOException,
                               AutomationException

The bias to be used during daylight time. This bias is relative to the time zone's BiasFromUTC.

Product Availability

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

Returns:

The daylightTimeBias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeBias

void setDaylightTimeBias(int daylightTimeBias)
                         throws IOException,
                                AutomationException

The bias to be used during daylight time. This bias is relative to the time zone's BiasFromUTC.

Product Availability

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

Parameters:

daylightTimeBias - The daylightTimeBias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeTransitionTime

_TimeZoneTransitionTime getStandardTimeTransitionTime()
                                                      throws IOException,
                                                             AutomationException

Date for transition to standard time.

Product Availability

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

Returns:

A Structure: com.esri.arcgis.system._TimeZoneTransitionTime (A com.esri.arcgis.system._TimeZoneTransitionTime COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardTimeTransitionTime

void setStandardTimeTransitionTime(_TimeZoneTransitionTime standardTimeTransitionTime)
                                   throws IOException,
                                          AutomationException

Date for transition to standard time.

Product Availability

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

Parameters:

standardTimeTransitionTime - A Structure: com.esri.arcgis.system._TimeZoneTransitionTime (A com.esri.arcgis.system._TimeZoneTransitionTime COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeBias

int getStandardTimeBias()
                        throws IOException,
                               AutomationException

The bias to be used during Standard time. This bias is relative to the time zone's BiasFromUTC.

Product Availability

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

Returns:

The standardTimeBias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardTimeBias

void setStandardTimeBias(int standardTimeBias)
                         throws IOException,
                                AutomationException

The bias to be used during Standard time. This bias is relative to the time zone's BiasFromUTC.

Product Availability

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

Parameters:

standardTimeBias - The standardTimeBias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.