com.esri.arcgis.geodatabase
Interface IQueryFilterDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
QueryFilter, SpatialFilter

public interface IQueryFilterDefinition
extends Serializable

Provides access to query filter definition properties.

Description

The IQueryFilterDefinition interface is used to define the set of FilterDef objects that are applied to the query. This set of objects is represented by the FilterDefs property. The other property on this interface PostfixClause is a string property that allows for addition text to be appended to the SQL generated by a query filter.

Product Availability

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


Method Summary
 IFilterDefs getFilterDefs()
          The filter definitions specified for this query filter.
 String getPostfixClause()
          A clause that will be appended to the end of the where clause.
 void setFilterDefsByRef(IFilterDefs filters)
          The filter definitions specified for this query filter.
 void setPostfixClause(String clause)
          A clause that will be appended to the end of the where clause.
 

Method Detail

getPostfixClause

String getPostfixClause()
                        throws IOException,
                               AutomationException
A clause that will be appended to the end of the where clause. Most commonly used for clauses like ORDER BY.

Remarks

The PostfixClause property allows for a postfix clause to be added to a query filter. The PostfixClause property is a string property. It can be used to specify an ORDER BY clause for the query. Historically, this clause has not been supported due to issues with placement in the SQL generated for spatial and/or versioned queries. This property ensures proper placement of the clause in the SQL generated by the system.

Please note, file geodatabases do not support the PostFixClause property, and any specifications within the PostFixClause will be ignored.

Product Availability

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

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

setPostfixClause

void setPostfixClause(String clause)
                      throws IOException,
                             AutomationException
A clause that will be appended to the end of the where clause. Most commonly used for clauses like ORDER BY.

Product Availability

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

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

getFilterDefs

IFilterDefs getFilterDefs()
                          throws IOException,
                                 AutomationException
The filter definitions specified for this query filter.

Remarks

The FilterDefs property contains the set of FilterDefs objects that will be applied to the query.

Product Availability

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

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

setFilterDefsByRef

void setFilterDefsByRef(IFilterDefs filters)
                        throws IOException,
                               AutomationException
The filter definitions specified for this query filter.

Product Availability

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

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