com.esri.arcgis.carto
Interface ITimeQueryFilter

All Superinterfaces:

Serializable

All Known Implementing Classes:

ImageQueryFilter, ITimeQueryFilterProxy, TimeQueryFilter

public interface ITimeQueryFilter
extends Serializable

Query filter that gives access to members that allow queries using time.

Description

The ITimeQueryFilter is used for creating queries to a data set that have a time component. It can be used instead of the normal query filter to hide all of the operations having to do with time zone differences. For example, you could create a query that returns features in the Pacific time zone. All data would be returned with a Pacific time zone time reference, regardless of what time reference was used to store the data.

Product Availability

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

Method Summary

ITimeReference	getOutputTimeReference() Output time reference.
int	getTimeRelation() Time relation for the time query.
ITimeValue	getTimeValue() Time value.
void	setOutputTimeReferenceByRef(ITimeReference timeReference) Output time reference.
void	setTimeRelation(int relation) Time relation for the time query.
void	setTimeValueByRef(ITimeValue timeValue) Time value.

Method Detail

getTimeValue

ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

Time value.

Description

This is the time value that is used for the time query. Only data that matches this time value will be returned.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValueByRef

void setTimeValueByRef(ITimeValue timeValue)
                       throws IOException,
                              AutomationException

Time value.

Product Availability

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

Parameters:

timeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputTimeReference

ITimeReference getOutputTimeReference()
                                      throws IOException,
                                             AutomationException

Output time reference.

Remarks

This is the Time Reference that will be used when returning data from the query. For example, if the output time reference is Pacific, and data is stored in Atlantic time zone, a feature with a time stamp of 4:00 PM will be returned with a time stamp of 1:00 PM (4:00 PM in Atlantic time is equivalent to 1:00 PM in Pacific time).

Note: This is only honored by MapServer's query function such as QueryData

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputTimeReferenceByRef

void setOutputTimeReferenceByRef(ITimeReference timeReference)
                                 throws IOException,
                                        AutomationException

Output time reference.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeRelation

int getTimeRelation()
                    throws IOException,
                           AutomationException

Time relation for the time query.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriTimeRelation constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeRelation

void setTimeRelation(int relation)
                     throws IOException,
                            AutomationException

Time relation for the time query.

Product Availability

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

Parameters:

relation - A com.esri.arcgis.carto.esriTimeRelation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.