com.esri.arcgis.system

Class TimeZoneRule

java.lang.Object

com.esri.arcgis.system.TimeZoneRule

All Implemented Interfaces:

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

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

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

Description 'An object that represents a time zone dynamic adjustments rule.' 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.ITimeZoneRule

IID, IID2cbfdcb1_c991_4f68_b5b1_919b1b1e6a25, 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
TimeZoneRule() Constructs a TimeZoneRule using ArcGIS Engine.
TimeZoneRule(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TimeZoneRule theTimeZoneRule = (TimeZoneRule) obj;

Method Summary

Modifier and Type	Method and Description
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.
int	getBiasFromUTC() The time zone bias from UTC in minutes.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getDaylightTimeBias() The bias to be used during daylight time.
_TimeZoneTransitionTime	getDaylightTimeTransitionTime() Date for transition to daylight time.
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.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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.
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	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.
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

TimeZoneRule

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

Constructs a TimeZoneRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TimeZoneRule

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

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

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

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

getYear

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

The year this rule is in effect.

Specified by:

getYear in interface ITimeZoneRule

Returns:

The year

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYear

public void setYear(int year)
             throws java.io.IOException,
                    AutomationException

The year this rule is in effect.

Specified by:

setYear in interface ITimeZoneRule

Parameters:

year - The year (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBiasFromUTC

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

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

Specified by:

getBiasFromUTC in interface ITimeZoneRule

Returns:

The biasFromUTC

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBiasFromUTC

public void setBiasFromUTC(int biasFromUTC)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setBiasFromUTC in interface ITimeZoneRule

Parameters:

biasFromUTC - The biasFromUTC (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeTransitionTime

public _TimeZoneTransitionTime getDaylightTimeTransitionTime()
                                                      throws java.io.IOException,
                                                             AutomationException

Date for transition to daylight time.

Specified by:

getDaylightTimeTransitionTime in interface ITimeZoneRule

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeTransitionTime

public void setDaylightTimeTransitionTime(_TimeZoneTransitionTime daylightTimeTransitionTime)
                                   throws java.io.IOException,
                                          AutomationException

Date for transition to daylight time.

Specified by:

setDaylightTimeTransitionTime in interface ITimeZoneRule

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeBias

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

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

Specified by:

getDaylightTimeBias in interface ITimeZoneRule

Returns:

The daylightTimeBias

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeBias

public void setDaylightTimeBias(int daylightTimeBias)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setDaylightTimeBias in interface ITimeZoneRule

Parameters:

daylightTimeBias - The daylightTimeBias (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandardTimeTransitionTime

public _TimeZoneTransitionTime getStandardTimeTransitionTime()
                                                      throws java.io.IOException,
                                                             AutomationException

Date for transition to standard time.

Specified by:

getStandardTimeTransitionTime in interface ITimeZoneRule

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStandardTimeTransitionTime

public void setStandardTimeTransitionTime(_TimeZoneTransitionTime standardTimeTransitionTime)
                                   throws java.io.IOException,
                                          AutomationException

Date for transition to standard time.

Specified by:

setStandardTimeTransitionTime in interface ITimeZoneRule

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandardTimeBias

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

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

Specified by:

getStandardTimeBias in interface ITimeZoneRule

Returns:

The standardTimeBias

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStandardTimeBias

public void setStandardTimeBias(int standardTimeBias)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setStandardTimeBias in interface ITimeZoneRule

Parameters:

standardTimeBias - The standardTimeBias (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