com.esri.arcgis.system
Interface ITimeZoneInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeZoneInfo

public interface ITimeZoneInfo
extends Serializable

Provides access to members that control the time zone information.

Description

ITimeZoneInfo contains all of the time zone and daylight savings time information relevant in a specific geographic region. In a given region, the rules for daylight savings time can change from year to year. Therefore, the ITimeZoneInfo interface provides a way to store and retrieve several years of different daylight savings time rules. When accessing several years of rules, you can start at the first rule year and repeatedly getting the "next rule year" until you reach the "last rule year".

Product Availability

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

Method Summary

void	addDynamicRule(ITimeZoneRule dynamicRule) Adds a dynamic adjustment to the time zone.
String	getCustomDescription() Custom description for the time zone.
String	getDaylightTimeName() The time zone name during daylight time.
ITimeZoneRule	getDefaultRule() The default time zone adjustment rule.
String	getDisplayName() Descriptive display name of the time zone.
ITimeZoneRule	getDynamicRule(int year) The dynamic adjustment rule for a specific year.
int	getDynamicRulesCount() Number of dynamic adjustment rules for the time zone.
int	getFirstDynamicRuleYear() The first dynamic adjustment rule year.
int	getLastDynamicRuleYear() The last dynamic adjustment rule year.
int	getNextDynamicRuleYear(int currentDynamicRuleYear) The next dynamic adjustment rule year that cyclicly proceeds the given dynamic adjustment rule year.
String	getStandardTimeName() The time zone name during standard time.
String	getWindowsID() Time zone Windows ID name.
void	setCustomDescription(String displayName) Custom description for the time zone.
void	setDaylightTimeName(String daylightTimeName) The time zone name during daylight time.
void	setDefaultRule(ITimeZoneRule defaultTimeZoneRule) The default time zone adjustment rule.
void	setDisplayName(String displayName) Descriptive display name of the time zone.
void	setStandardTimeName(String standardTimeName) The time zone name during standard time.
void	setWindowsID(String windowsID) Time zone Windows ID name.

Method Detail

getWindowsID

String getWindowsID()
                    throws IOException,
                           AutomationException

Time zone Windows ID name.

Product Availability

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

Returns:

The windowsID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWindowsID

void setWindowsID(String windowsID)
                  throws IOException,
                         AutomationException

Time zone Windows ID name.

Product Availability

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

Parameters:

windowsID - The windowsID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException

Descriptive display name of the time zone.

Product Availability

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

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(String displayName)
                    throws IOException,
                           AutomationException

Descriptive display name of the time zone.

Product Availability

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

Parameters:

displayName - The displayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomDescription

String getCustomDescription()
                            throws IOException,
                                   AutomationException

Custom description for the time zone.

Product Availability

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

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomDescription

void setCustomDescription(String displayName)
                          throws IOException,
                                 AutomationException

Custom description for the time zone.

Product Availability

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

Parameters:

displayName - The displayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeName

String getDaylightTimeName()
                           throws IOException,
                                  AutomationException

The time zone name during daylight time.

Product Availability

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

Returns:

The daylightTimeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeName

void setDaylightTimeName(String daylightTimeName)
                         throws IOException,
                                AutomationException

The time zone name during daylight time.

Product Availability

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

Parameters:

daylightTimeName - The daylightTimeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeName

String getStandardTimeName()
                           throws IOException,
                                  AutomationException

The time zone name during standard time.

Product Availability

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

Returns:

The standardTimeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardTimeName

void setStandardTimeName(String standardTimeName)
                         throws IOException,
                                AutomationException

The time zone name during standard time.

Product Availability

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

Parameters:

standardTimeName - The standardTimeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultRule

ITimeZoneRule getDefaultRule()
                             throws IOException,
                                    AutomationException

The default time zone adjustment rule.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultRule

void setDefaultRule(ITimeZoneRule defaultTimeZoneRule)
                    throws IOException,
                           AutomationException

The default time zone adjustment rule.

Product Availability

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

Parameters:

defaultTimeZoneRule - A reference to a com.esri.arcgis.system.ITimeZoneRule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicRulesCount

int getDynamicRulesCount()
                         throws IOException,
                                AutomationException

Number of dynamic adjustment rules for the time zone.

Product Availability

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

Returns:

The dynamicRulesCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstDynamicRuleYear

int getFirstDynamicRuleYear()
                            throws IOException,
                                   AutomationException

The first dynamic adjustment rule year.

Product Availability

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

Returns:

The firstDynamicRuleYear

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastDynamicRuleYear

int getLastDynamicRuleYear()
                           throws IOException,
                                  AutomationException

The last dynamic adjustment rule year.

Product Availability

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

Returns:

The lastDynamicRuleYear

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextDynamicRuleYear

int getNextDynamicRuleYear(int currentDynamicRuleYear)
                           throws IOException,
                                  AutomationException

The next dynamic adjustment rule year that cyclicly proceeds the given dynamic adjustment rule year.

Product Availability

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

Parameters:

currentDynamicRuleYear - The currentDynamicRuleYear (in)

Returns:

The nextDynamicRuleYear

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicRule

ITimeZoneRule getDynamicRule(int year)
                             throws IOException,
                                    AutomationException

The dynamic adjustment rule for a specific year.

Product Availability

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

Parameters:

year - The year (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDynamicRule

void addDynamicRule(ITimeZoneRule dynamicRule)
                    throws IOException,
                           AutomationException

Adds a dynamic adjustment to the time zone.

Product Availability

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

Parameters:

dynamicRule - A reference to a com.esri.arcgis.system.ITimeZoneRule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.