com.esri.arcgis.arcweb
Interface IArcWebSearchOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebSearchOptions

public interface IArcWebSearchOptions
extends Serializable

Provides access to members that define an ArcWeb search.

Product Availability

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


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

Method Detail

getStartIndex

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.

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

setStartIndex

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.

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

getCount

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.

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

setCount

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.

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

addOrderByFieldName

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.

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

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.

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

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException
An SQL WHERE clause to limit search results.

Product Availability

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

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

setWhereClause

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.

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