com.esri.arcgis.geodatabase
Class IQueryFilterDefinitionProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IQueryFilterDefinitionProxy

All Implemented Interfaces:

IQueryFilterDefinition, Externalizable, Serializable

Direct Known Subclasses:

IQueryFilterDefinition2Proxy

public class IQueryFilterDefinitionProxy
extends com.esri.arcgis.interop.Dispatch
implements IQueryFilterDefinition, Serializable

Provides access to query filter definition properties.

Superseded By

IQueryFilterDefinition2

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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IQueryFilterDefinitionProxy()
	IQueryFilterDefinitionProxy(Object obj)
protected	IQueryFilterDefinitionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IFilterDefs	getFilterDefs() The filter definitions specified for this query filter.
String	getPostfixClause() A clause that will be appended to the SELECT statement, following the where clause.
void	removeListener(String iidStr, Object theListener)
void	setFilterDefsByRef(IFilterDefs filters) The filter definitions specified for this query filter.
void	setPostfixClause(String clause) A clause that will be appended to the SELECT statement, following the where clause.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IQueryFilterDefinitionProxy

public IQueryFilterDefinitionProxy()

IQueryFilterDefinitionProxy

public IQueryFilterDefinitionProxy(Object obj)
                            throws IOException

Throws:

IOException

IQueryFilterDefinitionProxy

protected IQueryFilterDefinitionProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getPostfixClause

public String getPostfixClause()
                        throws IOException,
                               AutomationException

A clause that will be appended to the SELECT statement, following 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.

Product Availability

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

Specified by:

getPostfixClause in interface IQueryFilterDefinition

Returns:

The clause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPostfixClause

public void setPostfixClause(String clause)
                      throws IOException,
                             AutomationException

A clause that will be appended to the SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

Product Availability

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

Specified by:

setPostfixClause in interface IQueryFilterDefinition

Parameters:

clause - The clause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilterDefs

public 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.

Specified by:

getFilterDefs in interface IQueryFilterDefinition

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

public 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.

Specified by:

setFilterDefsByRef in interface IQueryFilterDefinition

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.