com.esri.arcgis.system
Class TimeDuration

java.lang.Object
  com.esri.arcgis.system.TimeDuration

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ITimeDuration, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

An object that represents a time duration value.

Description

A Time Duration represents a length of time that is not attached to any particular point in the time line. For example, "3 hours" is a Time Duration, but "The time from 3:00 to 6:00" is not a Time Duration. A Time Duration can be added to a TimeInstant to create a new TimeInstant.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TimeDuration()
Constructs a TimeDuration using ArcGIS Engine.

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

Method Summary

void	addDays(double value) Adds the input amount of days to the time duration.
void	addDuration(ITimeDuration timeDuration) Adds a time duration.
void	addHours(double value) Adds the input amount of hours to the time duration.
void	addMilliseconds(double value) Adds the input amount of milliseconds to the time duration.
void	addMinutes(double value) Adds the input amount of minutes to the time duration.
void	addNanoseconds(long value) Adds the input amount of nanoseconds to the time duration.
void	addSeconds(double value) Adds the input amount of seconds to the time duration.
void	addWeeks(double value) Adds the input amount of weeks to the time duration.
void	assign(IClone src) Assigns the properties of src to the receiver.
int	compare(ITimeDuration otherDuration) Compares this time duration to the other time duration.
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.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDays() The time duration days component.
int	getHours() The time duration hours component.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getMinutes() The time duration minutes component.
int	getNanoseconds() The time duration nanoseconds component.
int	getSeconds() The time duration seconds component.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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	isPositive() Indicates whether the time duration value is positive or negative.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isZero() Indicates whether the time duration's value is zero.
void	load(IStream pstm) load
double	queryDayFraction() The time duration day fraction portion as a day fraction.
long	queryDayFractionNanoseconds() The time duration day fraction portion as the number of nanoseconds elapsed since midnight.
long	queryTicks() Obtains the time duration as the number of ticks.
double	queryTotalDays() Obtains the time duration as total days floating point value.
double	queryTotalHours() Obtains the time duration as total hours floating point value.
double	queryTotalMinutes() Obtains the time duration as total minutes floating point value.
double	queryTotalSeconds() Obtains the time duration as total seconds floating point value.
_WKSTimeDuration	queryWKSTimeDuration() Obtains time as a WKSTimeDuration.
String	queryXMLTimeDurationString() Obtains the time duration as an XML time duration string.
void	readExternal(ObjectInput in)
void	reset() Reset the time duration to zero.
void	save(IStream pstm, int fClearDirty) save
void	scale(double scaleFactor) Scales the time duration by a scale factor.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDayFraction(double dayFraction) The time duration day fraction portion as a day fraction.
void	setDayFractionNanoseconds(long dayFractionNanoseconds) The time duration day fraction portion as the number of nanoseconds elapsed since midnight.
void	setDays(int days) The time duration days component.
void	setFromTicks(long ticks) Writes the time duration from a given number of ticks.
void	setFromWKSTimeDuration(_WKSTimeDuration timeDuration) Writes the time from a given WKSTimeDuration value.
void	setFromXMLTimeDurationString(String xmlTimeDurationString) Writes the time duration from an XML time duration string.
void	setHours(int hours) The time duration hours component.
void	setMinutes(int minutes) The time duration minutes component.
void	setNanoseconds(int nanoseconds) The time duration nanoseconds component.
void	setPositive(boolean positive) Indicates whether the time duration value is positive or negative.
void	setSeconds(int seconds) The time duration seconds component.
void	subtractDuration(ITimeDuration timeDuration) Subtracts a time duration.
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

TimeDuration

public TimeDuration()
             throws IOException,
                    UnknownHostException

Constructs a TimeDuration using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TimeDuration

public TimeDuration(Object obj)
             throws IOException

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

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

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

getDays

public int getDays()
            throws IOException,
                   AutomationException

The time duration days component.

Product Availability

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

Specified by:

getDays in interface ITimeDuration

Returns:

The days

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDays

public void setDays(int days)
             throws IOException,
                    AutomationException

The time duration days component.

Product Availability

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

Specified by:

setDays in interface ITimeDuration

Parameters:

days - The days (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHours

public int getHours()
             throws IOException,
                    AutomationException

The time duration hours component.

Product Availability

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

Specified by:

getHours in interface ITimeDuration

Returns:

The hours

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHours

public void setHours(int hours)
              throws IOException,
                     AutomationException

The time duration hours component.

Product Availability

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

Specified by:

setHours in interface ITimeDuration

Parameters:

hours - The hours (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinutes

public int getMinutes()
               throws IOException,
                      AutomationException

The time duration minutes component.

Product Availability

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

Specified by:

getMinutes in interface ITimeDuration

Returns:

The minutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinutes

public void setMinutes(int minutes)
                throws IOException,
                       AutomationException

The time duration minutes component.

Product Availability

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

Specified by:

setMinutes in interface ITimeDuration

Parameters:

minutes - The minutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeconds

public int getSeconds()
               throws IOException,
                      AutomationException

The time duration seconds component.

Product Availability

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

Specified by:

getSeconds in interface ITimeDuration

Returns:

The seconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeconds

public void setSeconds(int seconds)
                throws IOException,
                       AutomationException

The time duration seconds component.

Product Availability

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

Specified by:

setSeconds in interface ITimeDuration

Parameters:

seconds - The seconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNanoseconds

public int getNanoseconds()
                   throws IOException,
                          AutomationException

The time duration nanoseconds component.

Product Availability

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

Specified by:

getNanoseconds in interface ITimeDuration

Returns:

The nanoseconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNanoseconds

public void setNanoseconds(int nanoseconds)
                    throws IOException,
                           AutomationException

The time duration nanoseconds component.

Product Availability

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

Specified by:

setNanoseconds in interface ITimeDuration

Parameters:

nanoseconds - The nanoseconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPositive

public boolean isPositive()
                   throws IOException,
                          AutomationException

Indicates whether the time duration value is positive or negative.

Product Availability

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

Specified by:

isPositive in interface ITimeDuration

Returns:

The positive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPositive

public void setPositive(boolean positive)
                 throws IOException,
                        AutomationException

Indicates whether the time duration value is positive or negative.

Product Availability

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

Specified by:

setPositive in interface ITimeDuration

Parameters:

positive - The positive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryWKSTimeDuration

public _WKSTimeDuration queryWKSTimeDuration()
                                      throws IOException,
                                             AutomationException

Obtains time as a WKSTimeDuration.

Product Availability

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

Specified by:

queryWKSTimeDuration in interface ITimeDuration

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromWKSTimeDuration

public void setFromWKSTimeDuration(_WKSTimeDuration timeDuration)
                            throws IOException,
                                   AutomationException

Writes the time from a given WKSTimeDuration value.

Product Availability

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

Specified by:

setFromWKSTimeDuration in interface ITimeDuration

Parameters:

timeDuration - A Structure: com.esri.arcgis.system._WKSTimeDuration (A com.esri.arcgis.system._WKSTimeDuration COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryXMLTimeDurationString

public String queryXMLTimeDurationString()
                                  throws IOException,
                                         AutomationException

Obtains the time duration as an XML time duration string.

Product Availability

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

Specified by:

queryXMLTimeDurationString in interface ITimeDuration

Returns:

The xmlTimeDurationString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromXMLTimeDurationString

public void setFromXMLTimeDurationString(String xmlTimeDurationString)
                                  throws IOException,
                                         AutomationException

Writes the time duration from an XML time duration string.

Product Availability

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

Specified by:

setFromXMLTimeDurationString in interface ITimeDuration

Parameters:

xmlTimeDurationString - The xmlTimeDurationString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addWeeks

public void addWeeks(double value)
              throws IOException,
                     AutomationException

Adds the input amount of weeks to the time duration.

Product Availability

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

Specified by:

addWeeks in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDays

public void addDays(double value)
             throws IOException,
                    AutomationException

Adds the input amount of days to the time duration.

Product Availability

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

Specified by:

addDays in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addHours

public void addHours(double value)
              throws IOException,
                     AutomationException

Adds the input amount of hours to the time duration.

Product Availability

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

Specified by:

addHours in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMinutes

public void addMinutes(double value)
                throws IOException,
                       AutomationException

Adds the input amount of minutes to the time duration.

Product Availability

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

Specified by:

addMinutes in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSeconds

public void addSeconds(double value)
                throws IOException,
                       AutomationException

Adds the input amount of seconds to the time duration.

Product Availability

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

Specified by:

addSeconds in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMilliseconds

public void addMilliseconds(double value)
                     throws IOException,
                            AutomationException

Adds the input amount of milliseconds to the time duration.

Product Availability

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

Specified by:

addMilliseconds in interface ITimeDuration

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNanoseconds

public void addNanoseconds(long value)
                    throws IOException,
                           AutomationException

Adds the input amount of nanoseconds to the time duration.

Product Availability

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

Specified by:

addNanoseconds in interface ITimeDuration

Parameters:

value - Signed 64-bit int (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTotalDays

public double queryTotalDays()
                      throws IOException,
                             AutomationException

Obtains the time duration as total days floating point value.

Product Availability

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

Specified by:

queryTotalDays in interface ITimeDuration

Returns:

The totalDays

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTotalHours

public double queryTotalHours()
                       throws IOException,
                              AutomationException

Obtains the time duration as total hours floating point value.

Product Availability

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

Specified by:

queryTotalHours in interface ITimeDuration

Returns:

The totalHours

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTotalMinutes

public double queryTotalMinutes()
                         throws IOException,
                                AutomationException

Obtains the time duration as total minutes floating point value.

Product Availability

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

Specified by:

queryTotalMinutes in interface ITimeDuration

Returns:

The totalMinutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTotalSeconds

public double queryTotalSeconds()
                         throws IOException,
                                AutomationException

Obtains the time duration as total seconds floating point value.

Product Availability

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

Specified by:

queryTotalSeconds in interface ITimeDuration

Returns:

The totalSeconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDayFraction

public double queryDayFraction()
                        throws IOException,
                               AutomationException

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

Product Availability

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

Specified by:

queryDayFraction in interface ITimeDuration

Returns:

The dayFraction

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayFraction

public void setDayFraction(double dayFraction)
                    throws IOException,
                           AutomationException

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

Product Availability

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

Specified by:

setDayFraction in interface ITimeDuration

Parameters:

dayFraction - The dayFraction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDayFractionNanoseconds

public long queryDayFractionNanoseconds()
                                 throws IOException,
                                        AutomationException

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

Product Availability

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

Specified by:

queryDayFractionNanoseconds in interface ITimeDuration

Returns:

Signed 64-bit int

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDayFractionNanoseconds

public void setDayFractionNanoseconds(long dayFractionNanoseconds)
                               throws IOException,
                                      AutomationException

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

Product Availability

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

Specified by:

setDayFractionNanoseconds in interface ITimeDuration

Parameters:

dayFractionNanoseconds - Signed 64-bit int (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTicks

public long queryTicks()
                throws IOException,
                       AutomationException

Obtains the time duration as the number of ticks.

Remarks

Using the QueryTicks function allows you to find the Ticks value, which is used in many Windows time controls.

Product Availability

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

Specified by:

queryTicks in interface ITimeDuration

Returns:

Signed 64-bit int

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromTicks

public void setFromTicks(long ticks)
                  throws IOException,
                         AutomationException

Writes the time duration from a given number of ticks.

Product Availability

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

Specified by:

setFromTicks in interface ITimeDuration

Parameters:

ticks - Signed 64-bit int (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Reset the time duration to zero.

Product Availability

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

Specified by:

reset in interface ITimeDuration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scale

public void scale(double scaleFactor)
           throws IOException,
                  AutomationException

Scales the time duration by a scale factor.

Description

The scale function can be used to increase or decrease the given duration. For example, if you want to divide a time extent into 5 equal segments, you can get the TimeDuration from the TimeExent, then scale the TimeDuration by 1/5 and add the resulting TimeDuration to the TimeExtent's Start Time.

Product Availability

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

Specified by:

scale in interface ITimeDuration

Parameters:

scaleFactor - The scaleFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDuration

public void addDuration(ITimeDuration timeDuration)
                 throws IOException,
                        AutomationException

Adds a time duration.

Product Availability

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

Specified by:

addDuration in interface ITimeDuration

Parameters:

timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

subtractDuration

public void subtractDuration(ITimeDuration timeDuration)
                      throws IOException,
                             AutomationException

Subtracts a time duration.

Product Availability

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

Specified by:

subtractDuration in interface ITimeDuration

Parameters:

timeDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZero

public boolean isZero()
               throws IOException,
                      AutomationException

Indicates whether the time duration's value is zero.

Product Availability

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

Specified by:

isZero in interface ITimeDuration

Returns:

The isZero

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compare

public int compare(ITimeDuration otherDuration)
            throws IOException,
                   AutomationException

Compares this time duration to the other time duration. Returns -1 if this time duration's value is less, 1 if greater, and 0 otherwise.

Product Availability

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

Specified by:

compare in interface ITimeDuration

Parameters:

otherDuration - A reference to a com.esri.arcgis.system.ITimeDuration (in)

Returns:

The result

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