com.esri.arcgis.system
Interface ITimeZoneFactory

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITimeZoneFactory2
All Known Implementing Classes:
TimeZoneFactory

public interface ITimeZoneFactory
extends Serializable

Provides access to members that control the Time Zone Factory.

Description

The ITimeZoneFactory should be used whenever you need a reference to time zone. This is because the time zones are rules that are pre-defined, and using the pre-defined values saves memory, and prevents unnecessary errors. The time zone can be generated from well known ID (WKID) values, which can be queried from the time zone's Windows ID, or from the time zone's Olson ID.

Product Availability

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


Method Summary
 ILocaleInfo createLocaleInfoFromLocaleID(int localeID)
          Obtains the locale display name that corresponds to the given locale ID.
 ITimeReference createTimeReferenceFromWindowsID(String windowsID)
          Creates a time reference from a windows ID.
 ITimeZoneInfo createTimeZoneInfoFromWindowsID(String windowsID)
          Creates a time zone info from a windows ID.
 int getFirstLocaleID()
          The first locale ID.
 String getFirstTimeZoneWindowsID()
          The first time zone windows ID.
 int getNextLocaleID(int currenteLocaleID)
          The locale ID that cyclicly proceeds the given locale ID.
 String getNextTimeZoneWindowsID(String currentTimeZoneWindowsID)
          The time zone windows ID that cyclicly proceeds the given time zone windows ID.
 boolean isValidLocaleID(int localeID)
          Returns whether a given locale ID is valid for creating a locale info.
 boolean isValidTimeZoneWindowsID(String windowsID)
          Returns whether a given time zone windows ID is valid for creating a time zone info or a time reference.
 String queryLocalTimeZoneWindowsID()
          Obtains the machine's current local time zone Windows ID.
 String[] queryTimeZoneOlsonIDsFromWindowsID(String windowsID)
          Obtains all the olson time zone IDs that correspond to the given time zone windows ID.
 String queryTimeZoneWindowsIDFromOlsonID(String olsonID)
          Returns the time zone windows ID that corresponds to the given olson time zone ID.
 

Method Detail

createTimeZoneInfoFromWindowsID

ITimeZoneInfo createTimeZoneInfoFromWindowsID(String windowsID)
                                              throws IOException,
                                                     AutomationException
Creates a time zone info from a windows ID.

Product Availability

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

Parameters:
windowsID - The windowsID (in)
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.

createTimeReferenceFromWindowsID

ITimeReference createTimeReferenceFromWindowsID(String windowsID)
                                                throws IOException,
                                                       AutomationException
Creates a time reference from a windows ID.

Product Availability

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

Parameters:
windowsID - The windowsID (in)
Returns:
A reference to a com.esri.arcgis.system.ITimeReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTimeZoneWindowsIDFromOlsonID

String queryTimeZoneWindowsIDFromOlsonID(String olsonID)
                                         throws IOException,
                                                AutomationException
Returns the time zone windows ID that corresponds to the given olson time zone ID.

Product Availability

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

Parameters:
olsonID - The olsonID (in)
Returns:
The windowsID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTimeZoneOlsonIDsFromWindowsID

String[] queryTimeZoneOlsonIDsFromWindowsID(String windowsID)
                                            throws IOException,
                                                   AutomationException
Obtains all the olson time zone IDs that correspond to the given time zone windows ID.

Product Availability

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

Parameters:
windowsID - The windowsID (in)
Returns:
The olsonIDs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocalTimeZoneWindowsID

String queryLocalTimeZoneWindowsID()
                                   throws IOException,
                                          AutomationException
Obtains the machine's current local time zone Windows ID.

Product Availability

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

Returns:
The localTimeZoneWindowsID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstTimeZoneWindowsID

String getFirstTimeZoneWindowsID()
                                 throws IOException,
                                        AutomationException
The first time zone windows ID.

Product Availability

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

Returns:
The firstTimeZoneWindowsID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextTimeZoneWindowsID

String getNextTimeZoneWindowsID(String currentTimeZoneWindowsID)
                                throws IOException,
                                       AutomationException
The time zone windows ID that cyclicly proceeds the given time zone windows ID.

Product Availability

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

Parameters:
currentTimeZoneWindowsID - The currentTimeZoneWindowsID (in)
Returns:
The nextTimeZoneWindowsID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstLocaleID

int getFirstLocaleID()
                     throws IOException,
                            AutomationException
The first locale ID.

Product Availability

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

Returns:
The firstLocaleID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextLocaleID

int getNextLocaleID(int currenteLocaleID)
                    throws IOException,
                           AutomationException
The locale ID that cyclicly proceeds the given locale ID.

Product Availability

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

Parameters:
currenteLocaleID - The currenteLocaleID (in)
Returns:
The nextLocaleID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createLocaleInfoFromLocaleID

ILocaleInfo createLocaleInfoFromLocaleID(int localeID)
                                         throws IOException,
                                                AutomationException
Obtains the locale display name that corresponds to the given locale ID.

Product Availability

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

Parameters:
localeID - The localeID (in)
Returns:
A reference to a com.esri.arcgis.system.ILocaleInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValidTimeZoneWindowsID

boolean isValidTimeZoneWindowsID(String windowsID)
                                 throws IOException,
                                        AutomationException
Returns whether a given time zone windows ID is valid for creating a time zone info or a time reference.

Product Availability

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

Parameters:
windowsID - The windowsID (in)
Returns:
The isValid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValidLocaleID

boolean isValidLocaleID(int localeID)
                        throws IOException,
                               AutomationException
Returns whether a given locale ID is valid for creating a locale info.

Product Availability

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

Parameters:
localeID - The localeID (in)
Returns:
The isValid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.