com.esri.arcgis.system

Interface ITime

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITime2

All Known Implementing Classes:

ITime2Proxy, ITimeProxy, Time

public interface ITime
extends java.io.Serializable

COM Interface 'ITime'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to members that control the Time.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID66810d21_8de0_44ee_b26e_465ac09f161f
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
int	compare(ITime otherTime) Compares this time to the other time.
short	getDay() The time's gregorian day.
short	getHour() The time's hour.
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.
short	getYear() The time's gregorian year.
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	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.
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).

Field Detail

IID66810d21_8de0_44ee_b26e_465ac09f161f

static final int IID66810d21_8de0_44ee_b26e_465ac09f161f

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getYear

short getYear()
       throws java.io.IOException,
              AutomationException

The time's gregorian year.

Returns:

The year

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYear

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

The time's gregorian year.

Parameters:

year - The year (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMonth

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

The time's gregorian month.

Returns:

The month

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMonth

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

The time's gregorian month.

Parameters:

month - The month (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDay

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

The time's gregorian day.

Returns:

The day

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDay

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

The time's gregorian day.

Parameters:

day - The day (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHour

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

The time's hour.

Returns:

The hour

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHour

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

The time's hour.

Parameters:

hour - The hour (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinute

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

The time's minute.

Returns:

The minute

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinute

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

The time's minute.

Parameters:

minute - The minute (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSecond

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

The time's second.

Returns:

The second

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSecond

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

The time's second.

Parameters:

second - The second (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNanoseconds

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

The time's nanoseconds.

Returns:

The nanoseconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNanoseconds

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

The time's nanoseconds.

Parameters:

nanoseconds - The nanoseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryJulianDayNumber

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.

Returns:

The julianDayNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJulianDayNumber

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.

Parameters:

julianDayNumber - The julianDayNumber (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryDayFraction

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.

Returns:

The dayFraction

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDayFraction

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.

Parameters:

dayFraction - The dayFraction (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryNanosecondsSinceMidnight

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.

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNanosecondsSinceMidnight

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.

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

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

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

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toUTC

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toLocal

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTimeString

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

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

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

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.

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

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

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

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

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

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

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

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.

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

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.

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

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

Obtains the time as an XML time string.

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

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

Writes the time from an XML time string.

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

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

Obtains the time as an integer time.

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

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

Writes the time from an integer time.

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

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

Writes the time from a variant object.

Parameters:

object - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryOleTime

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

Obtains the time as an OLE automation date object.

Returns:

The oleTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromOleTime

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

Writes the time from an OLE automation date object.

Parameters:

oleTime - The oleTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryGregorianTime

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

Obtains the time as a gregorian date and time.

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

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

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

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

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

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

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromTicks

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.

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromCurrentUtcTime

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compare

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.

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.