com.esri.arcgis.geodatabaseextensions
Interface ITemporalQueryFilter

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITemporalQueryFilter2
All Known Implementing Classes:
TemporalQueryFilter

public interface ITemporalQueryFilter
extends Serializable

Provides access to properties and methods needed to manage temporal query filters.

Product Availability

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


Method Summary
 Object getEndingDate()
          Indicates the latest date included in the query.
 ITemporalOperator getRelativeTimeOperator()
          The object that contains a relative time to offset the temporal values.
 Object getStartingDate()
          Indicates the earliest date included in the query.
 int getTemporalConversion()
          The temporal conversion mode to use (if any) by the temporal query.
 int getTemporalOrder()
          Defines order in which temporal records are sorted.
 int getTemporalRelationship()
          The temporal relation used in the temporal query.
 void setEndingDate(Object pVal)
          Indicates the latest date included in the query.
 void setRelativeTimeOperator(ITemporalOperator pVal)
          The object that contains a relative time to offset the temporal values.
 void setStartingDate(Object pVal)
          Indicates the earliest date included in the query.
 void setTemporalConversion(int pVal)
          The temporal conversion mode to use (if any) by the temporal query.
 void setTemporalOrder(int pVal)
          Defines order in which temporal records are sorted.
 void setTemporalRelationship(int pVal)
          The temporal relation used in the temporal query.
 

Method Detail

getTemporalOrder

int getTemporalOrder()
                     throws IOException,
                            AutomationException
Defines order in which temporal records are sorted.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabaseextensions.enumTemporalOrder constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalOrder

void setTemporalOrder(int pVal)
                      throws IOException,
                             AutomationException
Defines order in which temporal records are sorted.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalOrder constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalRelationship

int getTemporalRelationship()
                            throws IOException,
                                   AutomationException
The temporal relation used in the temporal query.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabaseextensions.enumTemporalRelation constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalRelationship

void setTemporalRelationship(int pVal)
                             throws IOException,
                                    AutomationException
The temporal relation used in the temporal query.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalRelation constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartingDate

Object getStartingDate()
                       throws IOException,
                              AutomationException
Indicates the earliest date included in the query.

Product Availability

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartingDate

void setStartingDate(Object pVal)
                     throws IOException,
                            AutomationException
Indicates the earliest date included in the query.

Product Availability

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

Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndingDate

Object getEndingDate()
                     throws IOException,
                            AutomationException
Indicates the latest date included in the query.

Product Availability

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndingDate

void setEndingDate(Object pVal)
                   throws IOException,
                          AutomationException
Indicates the latest date included in the query.

Product Availability

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

Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalConversion

int getTemporalConversion()
                          throws IOException,
                                 AutomationException
The temporal conversion mode to use (if any) by the temporal query.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabaseextensions.enumTemporalConversion constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalConversion

void setTemporalConversion(int pVal)
                           throws IOException,
                                  AutomationException
The temporal conversion mode to use (if any) by the temporal query.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalConversion constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

ITemporalOperator getRelativeTimeOperator()
                                          throws IOException,
                                                 AutomationException
The object that contains a relative time to offset the temporal values.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws IOException,
                                    AutomationException
The object that contains a relative time to offset the temporal values.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.