com.esri.arcgis.carto
Interface ITimeTableDefinition

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CadastralFabricSubLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, ImageServerLayer, ITimeTableDefinitionProxy, MosaicLayer, StandaloneTable, TemporalFeatureLayer

public interface ITimeTableDefinition
extends java.io.Serializable

COM Interface 'ITimeTableDefinition'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to time related properties of a layer.' 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

static java.lang.String	IID Deprecated. Internal use only
static int	IID9f45df65_de39_4a88_b174_b2ad3d3020a8
static int	xxDummy Deprecated. Internal use only

Method Summary

ITimeExtent	getCustomTimeExtent() Custom time extent during which a layer is visible.
java.lang.String	getEndTimeFieldName() Name of the field that has end time for a row.
java.lang.String	getStartTimeFieldName() Name of the field that has start time for a row.
ITimeReference	getTimeReference() Time reference for the data.
java.lang.String	getTimeValueFormat() Time value format if the field name is of the string format.
java.lang.String	getTrackIDFieldName() Field that contains the rows that uniquely identifies the object whose time is being tracked.
void	setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) Custom time extent during which a layer is visible.
void	setEndTimeFieldName(java.lang.String fieldName) Name of the field that has end time for a row.
void	setStartTimeFieldName(java.lang.String fieldName) Name of the field that has start time for a row.
void	setTimeReferenceByRef(ITimeReference nativeTimeReference) Time reference for the data.
void	setTimeValueFormat(java.lang.String format) Time value format if the field name is of the string format.
void	setTrackIDFieldName(java.lang.String fieldName) Field that contains the rows that uniquely identifies the object whose time is being tracked.

Field Detail

IID9f45df65_de39_4a88_b174_b2ad3d3020a8

static final int IID9f45df65_de39_4a88_b174_b2ad3d3020a8

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

getStartTimeFieldName

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

Name of the field that has start time for a row.

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

void setStartTimeFieldName(java.lang.String fieldName)
                           throws java.io.IOException,
                                  AutomationException

Name of the field that has start time for a row.

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

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

Name of the field that has end time for a row.

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

void setEndTimeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

Name of the field that has end time for a row.

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

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

Time value format if the field name is of the string format.

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

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

Time value format if the field name is of the string format.

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

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

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

void setTrackIDFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference for the data.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws java.io.IOException,
                                  AutomationException

Time reference for the data.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

ITimeExtent getCustomTimeExtent()
                                throws java.io.IOException,
                                       AutomationException

Custom time extent during which a layer is visible.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomTimeExtentByRef

void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
                              throws java.io.IOException,
                                     AutomationException

Custom time extent during which a layer is visible.

Parameters:

layerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.