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, Externalizable, Serializable

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

An object that represents a time zone dynamic adjustments rule.

Description

The TimeZoneRule CoClass contains the rules used to determine the beginning and ending dates for daylight savings time in a region. There is only one start and end date within the class, so if the rules change from one year to the next within a given geographic region, several instances of the TimeZoneRule CoClass will be required (see the TimeZoneInfo CoClass).

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TimeZoneRule()
Constructs a TimeZoneRule using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(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 String	getClsid() getClsid.
int	getDaylightTimeBias() The bias to be used during daylight time.
_TimeZoneTransitionTime	getDaylightTimeTransitionTime() Date for transition to daylight time.
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(ObjectInput in)
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(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TimeZoneRule

public TimeZoneRule()
             throws IOException,
                    UnknownHostException

Constructs a TimeZoneRule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TimeZoneRule

public TimeZoneRule(Object obj)
             throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getYear

public int getYear()
            throws IOException,
                   AutomationException

The year this rule is in effect.

Product Availability

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

Specified by:

getYear in interface ITimeZoneRule

Returns:

The year

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYear

public 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.

Specified by:

setYear in interface ITimeZoneRule

Parameters:

year - The year (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBiasFromUTC

public 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.

Specified by:

getBiasFromUTC in interface ITimeZoneRule

Returns:

The biasFromUTC

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBiasFromUTC

public 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.

Specified by:

setBiasFromUTC in interface ITimeZoneRule

Parameters:

biasFromUTC - The biasFromUTC (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeTransitionTime

public _TimeZoneTransitionTime getDaylightTimeTransitionTime()
                                                      throws IOException,
                                                             AutomationException

Date for transition to daylight time.

Product Availability

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

Specified by:

getDaylightTimeTransitionTime in interface ITimeZoneRule

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

public void setDaylightTimeTransitionTime(_TimeZoneTransitionTime daylightTimeTransitionTime)
                                   throws IOException,
                                          AutomationException

Date for transition to daylight time.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDaylightTimeBias

public 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.

Specified by:

getDaylightTimeBias in interface ITimeZoneRule

Returns:

The daylightTimeBias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDaylightTimeBias

public 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.

Specified by:

setDaylightTimeBias in interface ITimeZoneRule

Parameters:

daylightTimeBias - The daylightTimeBias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeTransitionTime

public _TimeZoneTransitionTime getStandardTimeTransitionTime()
                                                      throws IOException,
                                                             AutomationException

Date for transition to standard time.

Product Availability

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

Specified by:

getStandardTimeTransitionTime in interface ITimeZoneRule

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

public void setStandardTimeTransitionTime(_TimeZoneTransitionTime standardTimeTransitionTime)
                                   throws IOException,
                                          AutomationException

Date for transition to standard time.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardTimeBias

public 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.

Specified by:

getStandardTimeBias in interface ITimeZoneRule

Returns:

The standardTimeBias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardTimeBias

public 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.

Specified by:

setStandardTimeBias in interface ITimeZoneRule

Parameters:

standardTimeBias - The standardTimeBias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException