com.esri.arcgis.system

Class TimeZoneInfo

java.lang.Object

com.esri.arcgis.system.TimeZoneInfo

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITimeZoneInfo, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class TimeZoneInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITimeZoneInfo, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'TimeZoneInfo'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An object that represents a time zone information.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.system.ITimeZoneInfo

IID, IID0f8fd6ab_ce6d_4bb2_a5ef_2f6035e304c5, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
TimeZoneInfo() Constructs a TimeZoneInfo using ArcGIS Engine.
TimeZoneInfo(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TimeZoneInfo theTimeZoneInfo = (TimeZoneInfo) obj;

Method Summary

Modifier and Type	Method and Description
void	addDynamicRule(ITimeZoneRule dynamicRule) Adds a dynamic adjustment to the time zone.
void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCustomDescription() Custom description for the time zone.
java.lang.String	getDaylightTimeName() The time zone name during daylight time.
ITimeZoneRule	getDefaultRule() The default time zone adjustment rule.
java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getLastDynamicRuleYear() The last dynamic adjustment rule year.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getNextDynamicRuleYear(int currentDynamicRuleYear) The next dynamic adjustment rule year that cyclicly proceeds the given dynamic adjustment rule year.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getStandardTimeName() The time zone name during standard time.
java.lang.String	getWindowsID() Time zone Windows ID name.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCustomDescription(java.lang.String displayName) Custom description for the time zone.
void	setDaylightTimeName(java.lang.String daylightTimeName) The time zone name during daylight time.
void	setDefaultRule(ITimeZoneRule defaultTimeZoneRule) The default time zone adjustment rule.
void	setDisplayName(java.lang.String displayName) Descriptive display name of the time zone.
void	setStandardTimeName(java.lang.String standardTimeName) The time zone name during standard time.
void	setWindowsID(java.lang.String windowsID) Time zone Windows ID name.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TimeZoneInfo

public TimeZoneInfo()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a TimeZoneInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TimeZoneInfo

public TimeZoneInfo(java.lang.Object obj)
             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeZoneInfo theTimeZoneInfo = (TimeZoneInfo) obj;

Construct a TimeZoneInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TimeZoneInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getWindowsID

public java.lang.String getWindowsID()
                              throws java.io.IOException,
                                     AutomationException

Time zone Windows ID name.

Specified by:

getWindowsID in interface ITimeZoneInfo

Returns:

The windowsID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWindowsID

public void setWindowsID(java.lang.String windowsID)
                  throws java.io.IOException,
                         AutomationException

Time zone Windows ID name.

Specified by:

setWindowsID in interface ITimeZoneInfo

Parameters:

windowsID - The windowsID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

Descriptive display name of the time zone.

Specified by:

getDisplayName in interface ITimeZoneInfo

Returns:

The displayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws java.io.IOException,
                           AutomationException

Descriptive display name of the time zone.

Specified by:

setDisplayName in interface ITimeZoneInfo

Parameters:

displayName - The displayName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomDescription

public java.lang.String getCustomDescription()
                                      throws java.io.IOException,
                                             AutomationException

Custom description for the time zone.

Specified by:

getCustomDescription in interface ITimeZoneInfo

Returns:

The displayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomDescription

public void setCustomDescription(java.lang.String displayName)
                          throws java.io.IOException,
                                 AutomationException

Custom description for the time zone.

Specified by:

setCustomDescription in interface ITimeZoneInfo

Parameters:

displayName - The displayName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeName

public java.lang.String getDaylightTimeName()
                                     throws java.io.IOException,
                                            AutomationException

The time zone name during daylight time.

Specified by:

getDaylightTimeName in interface ITimeZoneInfo

Returns:

The daylightTimeName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeName

public void setDaylightTimeName(java.lang.String daylightTimeName)
                         throws java.io.IOException,
                                AutomationException

The time zone name during daylight time.

Specified by:

setDaylightTimeName in interface ITimeZoneInfo

Parameters:

daylightTimeName - The daylightTimeName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeName

public java.lang.String getStandardTimeName()
                                     throws java.io.IOException,
                                            AutomationException

The time zone name during standard time.

Specified by:

getStandardTimeName in interface ITimeZoneInfo

Returns:

The standardTimeName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardTimeName

public void setStandardTimeName(java.lang.String standardTimeName)
                         throws java.io.IOException,
                                AutomationException

The time zone name during standard time.

Specified by:

setStandardTimeName in interface ITimeZoneInfo

Parameters:

standardTimeName - The standardTimeName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultRule

public ITimeZoneRule getDefaultRule()
                             throws java.io.IOException,
                                    AutomationException

The default time zone adjustment rule.

Specified by:

getDefaultRule in interface ITimeZoneInfo

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultRule

public void setDefaultRule(ITimeZoneRule defaultTimeZoneRule)
                    throws java.io.IOException,
                           AutomationException

The default time zone adjustment rule.

Specified by:

setDefaultRule in interface ITimeZoneInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicRulesCount

public int getDynamicRulesCount()
                         throws java.io.IOException,
                                AutomationException

Number of dynamic adjustment rules for the time zone.

Specified by:

getDynamicRulesCount in interface ITimeZoneInfo

Returns:

The dynamicRulesCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstDynamicRuleYear

public int getFirstDynamicRuleYear()
                            throws java.io.IOException,
                                   AutomationException

The first dynamic adjustment rule year.

Specified by:

getFirstDynamicRuleYear in interface ITimeZoneInfo

Returns:

The firstDynamicRuleYear

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastDynamicRuleYear

public int getLastDynamicRuleYear()
                           throws java.io.IOException,
                                  AutomationException

The last dynamic adjustment rule year.

Specified by:

getLastDynamicRuleYear in interface ITimeZoneInfo

Returns:

The lastDynamicRuleYear

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextDynamicRuleYear

public int getNextDynamicRuleYear(int currentDynamicRuleYear)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

getNextDynamicRuleYear in interface ITimeZoneInfo

Parameters:

currentDynamicRuleYear - The currentDynamicRuleYear (in)

Returns:

The nextDynamicRuleYear

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicRule

public ITimeZoneRule getDynamicRule(int year)
                             throws java.io.IOException,
                                    AutomationException

The dynamic adjustment rule for a specific year.

Specified by:

getDynamicRule in interface ITimeZoneInfo

Parameters:

year - The year (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDynamicRule

public void addDynamicRule(ITimeZoneRule dynamicRule)
                    throws java.io.IOException,
                           AutomationException

Adds a dynamic adjustment to the time zone.

Specified by:

addDynamicRule in interface ITimeZoneInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException