com.esri.arcgis.controls
Interface IARSearchDef

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcReaderSearchDef, IARSearchDefProxy

public interface IARSearchDef
extends Serializable

Provides access to members that control attribute and spatial search definitions.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


Method Summary
 int getSpatialRelationship()
          The spatial relationship between the search and target shapes.
 String getWhereClause()
          A SQL where clause for the search.
 void setARFeatureShape(IARFeature pARFeature, double bufferDistance)
          Set the search shape to the shape of a feature.
 void setEnvelopeShape(double xMin, double yMin, double xMax, double yMax, double bufferDistance)
          Set the search shape to an envelope.
 void setPointShape(double xCoord, double yCoord, double bufferDistance)
          Set the search shape to a point.
 void setSpatialRelationship(int spatialRel)
          The spatial relationship between the search and target shapes.
 void setWhereClause(String sWhereClause)
          A SQL where clause for the search.
 

Method Detail

setPointShape

void setPointShape(double xCoord,
                   double yCoord,
                   double bufferDistance)
                   throws IOException,
                          AutomationException
Set the search shape to a point.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xCoord - The xCoord (in)
yCoord - The yCoord (in)
bufferDistance - The bufferDistance (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvelopeShape

void setEnvelopeShape(double xMin,
                      double yMin,
                      double xMax,
                      double yMax,
                      double bufferDistance)
                      throws IOException,
                             AutomationException
Set the search shape to an envelope.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
bufferDistance - The bufferDistance (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setARFeatureShape

void setARFeatureShape(IARFeature pARFeature,
                       double bufferDistance)
                       throws IOException,
                              AutomationException
Set the search shape to the shape of a feature.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
pARFeature - A reference to a com.esri.arcgis.controls.IARFeature (in)
bufferDistance - The bufferDistance (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialRelationship

void setSpatialRelationship(int spatialRel)
                            throws IOException,
                                   AutomationException
The spatial relationship between the search and target shapes.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getSpatialRelationship

int getSpatialRelationship()
                           throws IOException,
                                  AutomationException
The spatial relationship between the search and target shapes.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

setWhereClause

void setWhereClause(String sWhereClause)
                    throws IOException,
                           AutomationException
A SQL where clause for the search.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
A SQL where clause for the search.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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