com.esri.arcgis.system

Class Time

java.lang.Object

com.esri.arcgis.system.Time

All Implemented Interfaces:

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

public class Time
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITime, ITime2, ITimeOffsetOperator, IXMLSerialize, IXMLVersionSupport, IClone, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'Time'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An object that represents a date and time value.' 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.ITime2

IID, IID30eae8e1_26b2_4e57_a3f2_8ae7c7db2455, xxDummy

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

IID66810d21_8de0_44ee_b26e_465ac09f161f

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

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

Method Summary

Modifier and Type	Method and Description
void	addDays(double value) Adds the input amount of days.
void	addDuration(ITimeDuration timeDuration) Adds a time duration.
void	addHours(double value) Adds the input amount of hours.
void	addMilliseconds(double value) Adds the input amount of milliseconds.
void	addMinutes(double value) Adds the input amount of minutes.
boolean	addMonths(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate) Adds the input amount of months.
void	addNanoseconds(long value) Adds the input amount of nanoseconds.
void	addSeconds(double value) Adds the input amount of seconds.
void	addWeeks(double value) Adds the input amount of weeks.
boolean	addYears(double value, boolean preserveEndOfMonth, boolean goForwardOnInvalidDate) Adds the input amount of years.
void	assign(IClone src) Assigns the properties of src to the receiver.
int	compare(ITime otherTime) Compares this time to the other time.
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.
short	getDay() The time's gregorian day.
short	getDayOfWeek() The day number of the week, starting with 1 for Sunday.
short	getDayOfYear() The day number of the year, starting with 1 for the first day of the year.
short	getHour() The time's hour.
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).
short	getMinute() The time's minute.
short	getMonth() The time's gregorian month.
int	getNanoseconds() The time's nanoseconds.
short	getSecond() The time's second.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
short	getWeekOfMonth(short startDayOfWeek) The week number of the month, starting with 1 for the first week of the month.
short	getWeekOfYear(short startDayOfWeek) The week number of the year, starting with 1 for first week of the year.
short	getYear() The time's gregorian year.
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
double	queryDayFraction() The time's time portion as a day fraction.
_WKSDateTime	queryGregorianTime() Obtains the time as a gregorian date and time.
long	queryIntegerTime(int integerTimeFormat) Obtains the time as an integer time.
int	queryJulianDayNumber() The Time's date portion as a julian (Julius Scaliger) day number.
long	queryNanosecondsSinceMidnight() The time's time portion as the number of nanoseconds elapsed since midnight.
java.util.Date	queryOleTime() Obtains the time as an OLE automation date object.
long	queryTicks() Obtains the time as the number of ticks since January 1, 0001 AD (Anno Domini).
java.lang.String	queryTimeString(int timeStringFormat) Obtains the time as a string, based on the given time string format.
java.lang.String	queryTimeStringCurrentLocale(int timeLocaleFormat) Obtains the time as a string, based on the current locale.
java.lang.String	queryTimeStringCustom(java.lang.String timeStringFormat, int localeID, java.lang.String amSymbol, java.lang.String pmSymbol) Obtains the time as a string, based on the given custom time string format, and locale properties.
java.lang.String	queryXMLTimeString(ITimeReference timeReference) Obtains the time as an XML time string.
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	setDay(short day) The time's gregorian day.
void	setDayFraction(double dayFraction) The time's time portion as a day fraction.
void	setFromCurrentLocalTime() Writes the time to the current date and time on this machine, expressed as the local time.
void	setFromCurrentUtcTime() Writes the time to the current date and time on this machine, expressed as the Coordinated Universal Time (UTC).
void	setFromGregorianTime(_WKSDateTime gregorianTime) Obtains the time from a given gregorian date and time value.
void	setFromIntegerTime(int integerTimeFormat, long integerTime) Writes the time from an integer time.
void	setFromObject(java.lang.Object object) Writes the time from a variant object.
void	setFromOleTime(java.util.Date oleTime) Writes the time from an OLE automation date object.
void	setFromTicks(long ticks) Writes the time from a given number of ticks since January 1, 0001 AD (Anno Domini) value.
void	setFromTimeString(int timeStringFormat, java.lang.String timeString) Writes the time from a string, based on the given time string format.
void	setFromTimeStringCurrentLocale(int timeLocaleFormat, java.lang.String timeString) Obtains the time from a string, based on the current locale.
void	setFromTimeStringCustom(java.lang.String timeStringFormat, int localeID, java.lang.String amSymbol, java.lang.String pmSymbol, java.lang.String timeString) Writes the time from a string, based on the given custom time string formats, and locale properties.
int	setFromXMLTimeString(java.lang.String xmlTimeString) Writes the time from an XML time string.
void	setHour(short hour) The time's hour.
void	setJulianDayNumber(int julianDayNumber) The Time's date portion as a julian (Julius Scaliger) day number.
void	setMinute(short minute) The time's minute.
void	setMonth(short month) The time's gregorian month.
void	setNanoseconds(int nanoseconds) The time's nanoseconds.
void	setNanosecondsSinceMidnight(long nanosecondsSinceMidnight) The time's time portion as the number of nanoseconds elapsed since midnight.
void	setSecond(short second) The time's second.
void	setYear(short year) The time's gregorian year.
void	snapToEndOfMonth() Adjust the day value, to the last day in the current month and year.
void	subtractDuration(ITimeDuration timeDuration) Subtracts a time duration.
ITimeDuration	subtractTime(ITime time) Subtracts a given time, and returns the time duration result.
void	toLocal() Converts the time from Coordinated Universal Time (UTC) value to local (to this machine) time.
void	toUTC() Converts the time from local (to this machine) time value to Coordinated Universal Time (UTC).
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

Time

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

Constructs a Time using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Time

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

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

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

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 short getYear()
              throws java.io.IOException,
                     AutomationException

The time's gregorian year.

Specified by:

getYear in interface ITime

Returns:

The year

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYear

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

The time's gregorian year.

Specified by:

setYear in interface ITime

Parameters:

year - The year (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMonth

public short getMonth()
               throws java.io.IOException,
                      AutomationException

The time's gregorian month.

Specified by:

getMonth in interface ITime

Returns:

The month

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMonth

public void setMonth(short month)
              throws java.io.IOException,
                     AutomationException

The time's gregorian month.

Specified by:

setMonth in interface ITime

Parameters:

month - The month (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDay

public short getDay()
             throws java.io.IOException,
                    AutomationException

The time's gregorian day.

Specified by:

getDay in interface ITime

Returns:

The day

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDay

public void setDay(short day)
            throws java.io.IOException,
                   AutomationException

The time's gregorian day.

Specified by:

setDay in interface ITime

Parameters:

day - The day (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHour

public short getHour()
              throws java.io.IOException,
                     AutomationException

The time's hour.

Specified by:

getHour in interface ITime

Returns:

The hour

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHour

public void setHour(short hour)
             throws java.io.IOException,
                    AutomationException

The time's hour.

Specified by:

setHour in interface ITime

Parameters:

hour - The hour (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinute

public short getMinute()
                throws java.io.IOException,
                       AutomationException

The time's minute.

Specified by:

getMinute in interface ITime

Returns:

The minute

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinute

public void setMinute(short minute)
               throws java.io.IOException,
                      AutomationException

The time's minute.

Specified by:

setMinute in interface ITime

Parameters:

minute - The minute (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSecond

public short getSecond()
                throws java.io.IOException,
                       AutomationException

The time's second.

Specified by:

getSecond in interface ITime

Returns:

The second

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSecond

public void setSecond(short second)
               throws java.io.IOException,
                      AutomationException

The time's second.

Specified by:

setSecond in interface ITime

Parameters:

second - The second (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNanoseconds

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

The time's nanoseconds.

Specified by:

getNanoseconds in interface ITime

Returns:

The nanoseconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNanoseconds

public void setNanoseconds(int nanoseconds)
                    throws java.io.IOException,
                           AutomationException

The time's nanoseconds.

Specified by:

setNanoseconds in interface ITime

Parameters:

nanoseconds - The nanoseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryJulianDayNumber

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

The Time's date portion as a julian (Julius Scaliger) day number. Corresponds to the Year, Month, and Day properties.

Specified by:

queryJulianDayNumber in interface ITime

Returns:

The julianDayNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJulianDayNumber

public void setJulianDayNumber(int julianDayNumber)
                        throws java.io.IOException,
                               AutomationException

The Time's date portion as a julian (Julius Scaliger) day number. Corresponds to the Year, Month, and Day properties.

Specified by:

setJulianDayNumber in interface ITime

Parameters:

julianDayNumber - The julianDayNumber (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryDayFraction

public double queryDayFraction()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

queryDayFraction in interface ITime

Returns:

The dayFraction

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDayFraction

public void setDayFraction(double dayFraction)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setDayFraction in interface ITime

Parameters:

dayFraction - The dayFraction (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryNanosecondsSinceMidnight

public long queryNanosecondsSinceMidnight()
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

queryNanosecondsSinceMidnight in interface ITime

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNanosecondsSinceMidnight

public void setNanosecondsSinceMidnight(long nanosecondsSinceMidnight)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

setNanosecondsSinceMidnight in interface ITime

Parameters:

nanosecondsSinceMidnight - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

subtractTime

public ITimeDuration subtractTime(ITime time)
                           throws java.io.IOException,
                                  AutomationException

Subtracts a given time, and returns the time duration result.

Specified by:

subtractTime in interface ITime

Parameters:

time - A reference to a com.esri.arcgis.system.ITime (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

snapToEndOfMonth

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

Adjust the day value, to the last day in the current month and year.

Specified by:

snapToEndOfMonth in interface ITime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toUTC

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

Converts the time from local (to this machine) time value to Coordinated Universal Time (UTC).

Specified by:

toUTC in interface ITime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toLocal

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

Converts the time from Coordinated Universal Time (UTC) value to local (to this machine) time.

Specified by:

toLocal in interface ITime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTimeString

public java.lang.String queryTimeString(int timeStringFormat)
                                 throws java.io.IOException,
                                        AutomationException

Obtains the time as a string, based on the given time string format.

Specified by:

queryTimeString in interface ITime

Parameters:

timeStringFormat - A com.esri.arcgis.system.esriTimeStringFormat constant (in)

Returns:

The timeString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromTimeString

public void setFromTimeString(int timeStringFormat,
                              java.lang.String timeString)
                       throws java.io.IOException,
                              AutomationException

Writes the time from a string, based on the given time string format.

Specified by:

setFromTimeString in interface ITime

Parameters:

timeStringFormat - A com.esri.arcgis.system.esriTimeStringFormat constant (in)

timeString - The timeString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTimeStringCurrentLocale

public java.lang.String queryTimeStringCurrentLocale(int timeLocaleFormat)
                                              throws java.io.IOException,
                                                     AutomationException

Obtains the time as a string, based on the current locale.

Specified by:

queryTimeStringCurrentLocale in interface ITime

Parameters:

timeLocaleFormat - A com.esri.arcgis.system.esriTimeLocaleFormat constant (in)

Returns:

The timeString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromTimeStringCurrentLocale

public void setFromTimeStringCurrentLocale(int timeLocaleFormat,
                                           java.lang.String timeString)
                                    throws java.io.IOException,
                                           AutomationException

Obtains the time from a string, based on the current locale.

Specified by:

setFromTimeStringCurrentLocale in interface ITime

Parameters:

timeLocaleFormat - A com.esri.arcgis.system.esriTimeLocaleFormat constant (in)

timeString - The timeString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTimeStringCustom

public java.lang.String queryTimeStringCustom(java.lang.String timeStringFormat,
                                              int localeID,
                                              java.lang.String amSymbol,
                                              java.lang.String pmSymbol)
                                       throws java.io.IOException,
                                              AutomationException

Obtains the time as a string, based on the given custom time string format, and locale properties.

Specified by:

queryTimeStringCustom in interface ITime

Parameters:

timeStringFormat - The timeStringFormat (in)

localeID - The localeID (in)

amSymbol - The amSymbol (in)

pmSymbol - The pmSymbol (in)

Returns:

The timeString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromTimeStringCustom

public void setFromTimeStringCustom(java.lang.String timeStringFormat,
                                    int localeID,
                                    java.lang.String amSymbol,
                                    java.lang.String pmSymbol,
                                    java.lang.String timeString)
                             throws java.io.IOException,
                                    AutomationException

Writes the time from a string, based on the given custom time string formats, and locale properties.

Specified by:

setFromTimeStringCustom in interface ITime

Parameters:

timeStringFormat - The timeStringFormat (in)

localeID - The localeID (in)

amSymbol - The amSymbol (in)

pmSymbol - The pmSymbol (in)

timeString - The timeString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryXMLTimeString

public java.lang.String queryXMLTimeString(ITimeReference timeReference)
                                    throws java.io.IOException,
                                           AutomationException

Obtains the time as an XML time string.

Specified by:

queryXMLTimeString in interface ITime

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Returns:

The xmlTimeString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromXMLTimeString

public int setFromXMLTimeString(java.lang.String xmlTimeString)
                         throws java.io.IOException,
                                AutomationException

Writes the time from an XML time string.

Specified by:

setFromXMLTimeString in interface ITime

Parameters:

xmlTimeString - The xmlTimeString (in)

Returns:

The timeZoneBiasFromUTC

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryIntegerTime

public long queryIntegerTime(int integerTimeFormat)
                      throws java.io.IOException,
                             AutomationException

Obtains the time as an integer time.

Specified by:

queryIntegerTime in interface ITime

Parameters:

integerTimeFormat - A com.esri.arcgis.system.esriIntegerTimeFormat constant (in)

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromIntegerTime

public void setFromIntegerTime(int integerTimeFormat,
                               long integerTime)
                        throws java.io.IOException,
                               AutomationException

Writes the time from an integer time.

Specified by:

setFromIntegerTime in interface ITime

Parameters:

integerTimeFormat - A com.esri.arcgis.system.esriIntegerTimeFormat constant (in)

integerTime - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromObject

public void setFromObject(java.lang.Object object)
                   throws java.io.IOException,
                          AutomationException

Writes the time from a variant object.

Specified by:

setFromObject in interface ITime

Parameters:

object - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryOleTime

public java.util.Date queryOleTime()
                            throws java.io.IOException,
                                   AutomationException

Obtains the time as an OLE automation date object.

Specified by:

queryOleTime in interface ITime

Returns:

The oleTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromOleTime

public void setFromOleTime(java.util.Date oleTime)
                    throws java.io.IOException,
                           AutomationException

Writes the time from an OLE automation date object.

Specified by:

setFromOleTime in interface ITime

Parameters:

oleTime - The oleTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryGregorianTime

public _WKSDateTime queryGregorianTime()
                                throws java.io.IOException,
                                       AutomationException

Obtains the time as a gregorian date and time.

Specified by:

queryGregorianTime in interface ITime

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromGregorianTime

public void setFromGregorianTime(_WKSDateTime gregorianTime)
                          throws java.io.IOException,
                                 AutomationException

Obtains the time from a given gregorian date and time value.

Specified by:

setFromGregorianTime in interface ITime

Parameters:

gregorianTime - A Structure: com.esri.arcgis.system._WKSDateTime (A com.esri.arcgis.system._WKSDateTime COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTicks

public long queryTicks()
                throws java.io.IOException,
                       AutomationException

Obtains the time as the number of ticks since January 1, 0001 AD (Anno Domini).

Specified by:

queryTicks in interface ITime

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromTicks

public void setFromTicks(long ticks)
                  throws java.io.IOException,
                         AutomationException

Writes the time from a given number of ticks since January 1, 0001 AD (Anno Domini) value.

Specified by:

setFromTicks in interface ITime

Parameters:

ticks - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromCurrentLocalTime

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

Writes the time to the current date and time on this machine, expressed as the local time.

Specified by:

setFromCurrentLocalTime in interface ITime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromCurrentUtcTime

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

Writes the time to the current date and time on this machine, expressed as the Coordinated Universal Time (UTC).

Specified by:

setFromCurrentUtcTime in interface ITime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compare

public int compare(ITime otherTime)
            throws java.io.IOException,
                   AutomationException

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

Specified by:

compare in interface ITime

Parameters:

otherTime - A reference to a com.esri.arcgis.system.ITime (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDayOfWeek

public short getDayOfWeek()
                   throws java.io.IOException,
                          AutomationException

The day number of the week, starting with 1 for Sunday.

Specified by:

getDayOfWeek in interface ITime2

Returns:

The dayNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDayOfYear

public short getDayOfYear()
                   throws java.io.IOException,
                          AutomationException

The day number of the year, starting with 1 for the first day of the year.

Specified by:

getDayOfYear in interface ITime2

Returns:

The dayNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeekOfMonth

public short getWeekOfMonth(short startDayOfWeek)
                     throws java.io.IOException,
                            AutomationException

The week number of the month, starting with 1 for the first week of the month. Use startDayOfWeek = 1 to specify that weeks start on Sunday, and 2 on Monday.

Specified by:

getWeekOfMonth in interface ITime2

Parameters:

startDayOfWeek - The startDayOfWeek (in)

Returns:

The weekNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeekOfYear

public short getWeekOfYear(short startDayOfWeek)
                    throws java.io.IOException,
                           AutomationException

The week number of the year, starting with 1 for first week of the year. Use startDayOfWeek = 1 to specify that weeks start on Sunday, and 2 on Monday.

Specified by:

getWeekOfYear in interface ITime2

Parameters:

startDayOfWeek - The startDayOfWeek (in)

Returns:

The weekNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDuration

public void addDuration(ITimeDuration timeDuration)
                 throws java.io.IOException,
                        AutomationException

Adds a time duration.

Specified by:

addDuration in interface ITimeOffsetOperator

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

subtractDuration

public void subtractDuration(ITimeDuration timeDuration)
                      throws java.io.IOException,
                             AutomationException

Subtracts a time duration.

Specified by:

subtractDuration in interface ITimeOffsetOperator

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addYears

public boolean addYears(double value,
                        boolean preserveEndOfMonth,
                        boolean goForwardOnInvalidDate)
                 throws java.io.IOException,
                        AutomationException

Adds the input amount of years.

Specified by:

addYears in interface ITimeOffsetOperator

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMonths

public boolean addMonths(double value,
                         boolean preserveEndOfMonth,
                         boolean goForwardOnInvalidDate)
                  throws java.io.IOException,
                         AutomationException

Adds the input amount of months.

Specified by:

addMonths in interface ITimeOffsetOperator

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeeks

public void addWeeks(double value)
              throws java.io.IOException,
                     AutomationException

Adds the input amount of weeks.

Specified by:

addWeeks in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDays

public void addDays(double value)
             throws java.io.IOException,
                    AutomationException

Adds the input amount of days.

Specified by:

addDays in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addHours

public void addHours(double value)
              throws java.io.IOException,
                     AutomationException

Adds the input amount of hours.

Specified by:

addHours in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMinutes

public void addMinutes(double value)
                throws java.io.IOException,
                       AutomationException

Adds the input amount of minutes.

Specified by:

addMinutes in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSeconds

public void addSeconds(double value)
                throws java.io.IOException,
                       AutomationException

Adds the input amount of seconds.

Specified by:

addSeconds in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMilliseconds

public void addMilliseconds(double value)
                     throws java.io.IOException,
                            AutomationException

Adds the input amount of milliseconds.

Specified by:

addMilliseconds in interface ITimeOffsetOperator

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addNanoseconds

public void addNanoseconds(long value)
                    throws java.io.IOException,
                           AutomationException

Adds the input amount of nanoseconds.

Specified by:

addNanoseconds in interface ITimeOffsetOperator

Parameters:

value - Signed 64-bit int (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