com.esri.arcgis.system

Interface IDateFormat

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IDateFormat2

All Known Implementing Classes:

DateFormat, IDateFormat2Proxy, IDateFormatProxy

public interface IDateFormat
extends java.io.Serializable

COM Interface 'IDateFormat'. Generated 9/24/2024 11:01:27 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to members that format date 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	IID9fa0d58f_3fc7_45b4_95a3_db8961ed6e00
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	fromOADate(double oadate, int[] year, int[] month, int[] day, int[] hour, int[] minute, int[] second, int[] millisecond, int[] dayOfWeek) Convert OADate to date time with the milliseconds preserved.
int	getCalendar() Calendar used for date time formating.
java.lang.String	getFormat() Format used to convert date time to string, i.e., yyyy/MM/dd.
java.lang.String	getLocale() Locale used for date time formating, i.e., en-US, zh-CN, ja-JP.
void	setCalendar(int calendarType) Calendar used for date time formating.
void	setFormat(java.lang.String format) Format used to convert date time to string, i.e., yyyy/MM/dd.
void	setLocale(java.lang.String locale) Locale used for date time formating, i.e., en-US, zh-CN, ja-JP.
double	toOADate(int year, int month, int day, int hour, int minute, int second, int millisecond) Convert date time to OADate with the milliseconds preserved.

Field Detail

IID9fa0d58f_3fc7_45b4_95a3_db8961ed6e00

static final int IID9fa0d58f_3fc7_45b4_95a3_db8961ed6e00

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

setFormat

void setFormat(java.lang.String format)
        throws java.io.IOException,
               AutomationException

Format used to convert date time to string, i.e., yyyy/MM/dd.

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

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

Format used to convert date time to string, i.e., yyyy/MM/dd.

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocale

void setLocale(java.lang.String locale)
        throws java.io.IOException,
               AutomationException

Locale used for date time formating, i.e., en-US, zh-CN, ja-JP. If not set, the user default locale will be used.

Parameters:

locale - The locale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocale

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

Locale used for date time formating, i.e., en-US, zh-CN, ja-JP. If not set, the user default locale will be used.

Returns:

The locale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCalendar

void setCalendar(int calendarType)
          throws java.io.IOException,
                 AutomationException

Calendar used for date time formating. If not set, the default calendar for the locale will be used.

Parameters:

calendarType - A com.esri.arcgis.system.esriCalendarEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCalendar

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

Calendar used for date time formating. If not set, the default calendar for the locale will be used.

Returns:

A com.esri.arcgis.system.esriCalendarEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toOADate

double toOADate(int year,
                int month,
                int day,
                int hour,
                int minute,
                int second,
                int millisecond)
         throws java.io.IOException,
                AutomationException

Convert date time to OADate with the milliseconds preserved.

Parameters:

year - The year (in)

month - The month (in)

day - The day (in)

hour - The hour (in)

minute - The minute (in)

second - The second (in)

millisecond - The millisecond (in)

Returns:

The oadate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromOADate

void fromOADate(double oadate,
                int[] year,
                int[] month,
                int[] day,
                int[] hour,
                int[] minute,
                int[] second,
                int[] millisecond,
                int[] dayOfWeek)
         throws java.io.IOException,
                AutomationException

Convert OADate to date time with the milliseconds preserved. Day of week is an integer between 0 and 6, where 0 indicates Sunday and 6 indicates Saturday.

Parameters:

oadate - The oadate (in)

year - The year (out: use single element array)

month - The month (out: use single element array)

day - The day (out: use single element array)

hour - The hour (out: use single element array)

minute - The minute (out: use single element array)

second - The second (out: use single element array)

millisecond - The millisecond (out: use single element array)

dayOfWeek - The dayOfWeek (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.