com.esri.arcgis.system

Interface ITimeDuration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITimeDurationProxy, TimeDuration

public interface ITimeDuration
extends java.io.Serializable

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

Description: 'Provides access to members that control the Time Duration.' 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	IID953dc994_aa0d_4193_9c1f_469b60d61711
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.
int	compare(ITimeDuration otherDuration) Compares this time duration to the other time duration.
int	getDays() The time duration days component.
int	getHours() The time duration hours component.
int	getMinutes() The time duration minutes component.
int	getNanoseconds() The time duration nanoseconds component.
int	getSeconds() The time duration seconds component.
boolean	isPositive() Indicates whether the time duration value is positive or negative.
boolean	isZero() Indicates whether the time duration's value is zero.
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.
java.lang.String	queryXMLTimeDurationString() Obtains the time duration as an XML time duration string.
void	reset() Reset the time duration to zero.
void	scale(double scaleFactor) Scales the time duration by a scale factor.
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(java.lang.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.

Field Detail

IID953dc994_aa0d_4193_9c1f_469b60d61711

static final int IID953dc994_aa0d_4193_9c1f_469b60d61711

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

getDays

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

The time duration days component.

Returns:

The days

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDays

void setDays(int days)
      throws java.io.IOException,
             AutomationException

The time duration days component.

Parameters:

days - The days (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHours

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

The time duration hours component.

Returns:

The hours

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHours

void setHours(int hours)
       throws java.io.IOException,
              AutomationException

The time duration hours component.

Parameters:

hours - The hours (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinutes

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

The time duration minutes component.

Returns:

The minutes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinutes

void setMinutes(int minutes)
         throws java.io.IOException,
                AutomationException

The time duration minutes component.

Parameters:

minutes - The minutes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeconds

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

The time duration seconds component.

Returns:

The seconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSeconds

void setSeconds(int seconds)
         throws java.io.IOException,
                AutomationException

The time duration seconds component.

Parameters:

seconds - The seconds (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 duration nanoseconds component.

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 duration nanoseconds component.

Parameters:

nanoseconds - The nanoseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPositive

boolean isPositive()
            throws java.io.IOException,
                   AutomationException

Indicates whether the time duration value is positive or negative.

Returns:

The positive

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPositive

void setPositive(boolean positive)
          throws java.io.IOException,
                 AutomationException

Indicates whether the time duration value is positive or negative.

Parameters:

positive - The positive (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryWKSTimeDuration

_WKSTimeDuration queryWKSTimeDuration()
                               throws java.io.IOException,
                                      AutomationException

Obtains time as a WKSTimeDuration.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromWKSTimeDuration

void setFromWKSTimeDuration(_WKSTimeDuration timeDuration)
                     throws java.io.IOException,
                            AutomationException

Writes the time from a given WKSTimeDuration value.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryXMLTimeDurationString

java.lang.String queryXMLTimeDurationString()
                                     throws java.io.IOException,
                                            AutomationException

Obtains the time duration as an XML time duration string.

Returns:

The xmlTimeDurationString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFromXMLTimeDurationString

void setFromXMLTimeDurationString(java.lang.String xmlTimeDurationString)
                           throws java.io.IOException,
                                  AutomationException

Writes the time duration from an XML time duration string.

Parameters:

xmlTimeDurationString - The xmlTimeDurationString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeeks

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

Adds the input amount of weeks to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDays

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

Adds the input amount of days to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addHours

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

Adds the input amount of hours to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMinutes

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

Adds the input amount of minutes to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSeconds

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

Adds the input amount of seconds to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMilliseconds

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

Adds the input amount of milliseconds to the time duration.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addNanoseconds

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

Adds the input amount of nanoseconds to the time duration.

Parameters:

value - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTotalDays

double queryTotalDays()
               throws java.io.IOException,
                      AutomationException

Obtains the time duration as total days floating point value.

Returns:

The totalDays

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTotalHours

double queryTotalHours()
                throws java.io.IOException,
                       AutomationException

Obtains the time duration as total hours floating point value.

Returns:

The totalHours

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTotalMinutes

double queryTotalMinutes()
                  throws java.io.IOException,
                         AutomationException

Obtains the time duration as total minutes floating point value.

Returns:

The totalMinutes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTotalSeconds

double queryTotalSeconds()
                  throws java.io.IOException,
                         AutomationException

Obtains the time duration as total seconds floating point value.

Returns:

The totalSeconds

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 duration day fraction 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 duration day fraction 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.

queryDayFractionNanoseconds

long queryDayFractionNanoseconds()
                          throws java.io.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.

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDayFractionNanoseconds

void setDayFractionNanoseconds(long dayFractionNanoseconds)
                        throws java.io.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.

Parameters:

dayFractionNanoseconds - Signed 64-bit int (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 duration as the number of ticks.

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 duration from a given number of ticks.

Parameters:

ticks - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Reset the time duration to zero.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

scale

void scale(double scaleFactor)
    throws java.io.IOException,
           AutomationException

Scales the time duration by a scale factor.

Parameters:

scaleFactor - The scaleFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDuration

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

Adds a time duration.

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

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

Subtracts a time duration.

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.

isZero

boolean isZero()
        throws java.io.IOException,
               AutomationException

Indicates whether the time duration's value is zero.

Returns:

The isZero

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compare

int compare(ITimeDuration otherDuration)
     throws java.io.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.

Parameters:

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

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.