com.esri.arcgis.arcweb
Class ArcWebSearchOptions

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebSearchOptions

All Implemented Interfaces:

IArcWebSearchOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebSearchOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebSearchOptions

A set of parameters used in ArcWeb searching procedures.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebSearchOptions()
Constructs a ArcWebSearchOptions using ArcGIS Engine.

ArcWebSearchOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebSearchOptions theArcWebSearchOptions = (ArcWebSearchOptions) obj;

Method Summary

void	addOrderByFieldName(String fieldName, boolean descending) A field name used for sorting the results.
void	addReturnFieldName(String fieldName) A field name used for sorting the results.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The number of records returned in the results (default is 20).
int	getStartIndex() The number of records to skip in the query (first record is 0 and default is 0).
String	getWhereClause() An SQL WHERE clause to limit search results.
int	hashCode() the hashcode for this object
void	setCount(int pCount) The number of records returned in the results (default is 20).
void	setStartIndex(int pStartIndex) The number of records to skip in the query (first record is 0 and default is 0).
void	setWhereClause(String whereClause) An SQL WHERE clause to limit search results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcWebSearchOptions

public ArcWebSearchOptions()
                    throws IOException,
                           UnknownHostException

Constructs a ArcWebSearchOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebSearchOptions

public ArcWebSearchOptions(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebSearchOptions theArcWebSearchOptions = (ArcWebSearchOptions) obj;

Construct a ArcWebSearchOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebSearchOptions.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getStartIndex

public int getStartIndex()
                  throws IOException,
                         AutomationException

The number of records to skip in the query (first record is 0 and default is 0).

Product Availability

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

Specified by:

getStartIndex in interface IArcWebSearchOptions

Returns:

The pStartIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartIndex

public void setStartIndex(int pStartIndex)
                   throws IOException,
                          AutomationException

The number of records to skip in the query (first record is 0 and default is 0).

Product Availability

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

Specified by:

setStartIndex in interface IArcWebSearchOptions

Parameters:

pStartIndex - The pStartIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of records returned in the results (default is 20).

Product Availability

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

Specified by:

getCount in interface IArcWebSearchOptions

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCount

public void setCount(int pCount)
              throws IOException,
                     AutomationException

The number of records returned in the results (default is 20).

Product Availability

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

Specified by:

setCount in interface IArcWebSearchOptions

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOrderByFieldName

public void addOrderByFieldName(String fieldName,
                                boolean descending)
                         throws IOException,
                                AutomationException

A field name used for sorting the results.

Product Availability

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

Specified by:

addOrderByFieldName in interface IArcWebSearchOptions

Parameters:

fieldName - The fieldName (in)

descending - The descending (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addReturnFieldName

public void addReturnFieldName(String fieldName)
                        throws IOException,
                               AutomationException

A field name used for sorting the results.

Product Availability

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

Specified by:

addReturnFieldName in interface IArcWebSearchOptions

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException

An SQL WHERE clause to limit search results.

Product Availability

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

Specified by:

getWhereClause in interface IArcWebSearchOptions

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

An SQL WHERE clause to limit search results.

Product Availability

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

Specified by:

setWhereClause in interface IArcWebSearchOptions

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.