com.esri.arcgis.controls
Interface IARSearchDef

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArcReaderSearchDef, IARSearchDefProxy

public interface IARSearchDef
extends java.io.Serializable

COM Interface 'IARSearchDef'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control attribute and spatial search definitions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_4_PUT_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID8ea32542_5b8b_4b1a_9fd8_eb88c0bc0d87
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getSpatialRelationship() The spatial relationship between the search and target shapes.
java.lang.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(java.lang.String sWhereClause) A SQL where clause for the search.

Field Detail

IID8ea32542_5b8b_4b1a_9fd8_eb88c0bc0d87

static final int IID8ea32542_5b8b_4b1a_9fd8_eb88c0bc0d87

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_PUT_NAME

static final java.lang.String DISPID_4_PUT_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

Method Detail

setPointShape

void setPointShape(double xCoord,
                   double yCoord,
                   double bufferDistance)
                   throws java.io.IOException,
                          AutomationException

Set the search shape to a point.

Parameters:

xCoord - The xCoord (in)

yCoord - The yCoord (in)

bufferDistance - The bufferDistance (in, optional, pass 0 if not required)

Throws:

java.io.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 java.io.IOException,
                             AutomationException

Set the search shape to an envelope.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setARFeatureShape

void setARFeatureShape(IARFeature pARFeature,
                       double bufferDistance)
                       throws java.io.IOException,
                              AutomationException

Set the search shape to the shape of a feature.

Parameters:

pARFeature - A reference to a com.esri.arcgis.controls.IARFeature (in)

bufferDistance - The bufferDistance (in, optional, pass 0 if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelationship

void setSpatialRelationship(int spatialRel)
                            throws java.io.IOException,
                                   AutomationException

The spatial relationship between the search and target shapes.

Parameters:

spatialRel - A com.esri.arcgis.controls.esriARSpatialRelationship constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelationship

int getSpatialRelationship()
                           throws java.io.IOException,
                                  AutomationException

The spatial relationship between the search and target shapes.

Returns:

A com.esri.arcgis.controls.esriARSpatialRelationship constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(java.lang.String sWhereClause)
                    throws java.io.IOException,
                           AutomationException

A SQL where clause for the search.

Parameters:

sWhereClause - The sWhereClause (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

A SQL where clause for the search.

Returns:

The sWhereClause

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.