com.esri.arcgis.system
Interface ITimeOffsetOperator

All Superinterfaces:

Serializable

All Known Implementing Classes:

Time, TimeExtent, TimeInstant

public interface ITimeOffsetOperator
extends Serializable

Provides access to time operations.

Description

This interface provides a mechanism to offset various types of time objects (such as TimeInstant, TimeExtent, etc.) The various methods provided allow you to shift the time object by the specified interval into the future. To shift the time object into the past, simply pass in a negative value to the desired function.

Product Availability

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

Method Summary

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	subtractDuration(ITimeDuration timeDuration) Subtracts a time duration.

Method Detail

addDuration

void addDuration(ITimeDuration timeDuration)
                 throws IOException,
                        AutomationException

Adds a time duration.

Product Availability

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

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

void subtractDuration(ITimeDuration timeDuration)
                      throws IOException,
                             AutomationException

Subtracts a time duration.

Product Availability

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

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.

addYears

boolean addYears(double value,
                 boolean preserveEndOfMonth,
                 boolean goForwardOnInvalidDate)
                 throws IOException,
                        AutomationException

Adds the input amount of years.

Product Availability

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

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMonths

boolean addMonths(double value,
                  boolean preserveEndOfMonth,
                  boolean goForwardOnInvalidDate)
                  throws IOException,
                         AutomationException

Adds the input amount of months.

Product Availability

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

Parameters:

value - The value (in)

preserveEndOfMonth - The preserveEndOfMonth (in)

goForwardOnInvalidDate - The goForwardOnInvalidDate (in)

Returns:

The dateWasAdjusted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addWeeks

void addWeeks(double value)
              throws IOException,
                     AutomationException

Adds the input amount of weeks.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDays

void addDays(double value)
             throws IOException,
                    AutomationException

Adds the input amount of days.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addHours

void addHours(double value)
              throws IOException,
                     AutomationException

Adds the input amount of hours.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMinutes

void addMinutes(double value)
                throws IOException,
                       AutomationException

Adds the input amount of minutes.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSeconds

void addSeconds(double value)
                throws IOException,
                       AutomationException

Adds the input amount of seconds.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMilliseconds

void addMilliseconds(double value)
                     throws IOException,
                            AutomationException

Adds the input amount of milliseconds.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNanoseconds

void addNanoseconds(long value)
                    throws IOException,
                           AutomationException

Adds the input amount of nanoseconds.

Product Availability

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

Parameters:

value - Signed 64-bit int (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.