com.esri.arcgis.carto
Interface IMapServerFindResults

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerFindResults

public interface IMapServerFindResults
extends Serializable

Provides access to the Map Server Find Results Interface.

Remarks

In order to control the amount of information MapServer needs to process for a query, a maximum number of records can be set. This value is contained in the MaxRecordCount property. The default value for this property is 500. If 600 features match a given query only the first 500 results will be returned. You will be unable to access the remaining 100 records. To be able to access these records the MaxRecordCount would need to be increased to 600. MaxRecordCount affects the following IMapServer methods: Find, Identify, QueryFeatureData, and QueryHyperlinks. It does not affect QueryFeatureCount, QueryFeatureIDs or the number of Rows of a MapServerRelationship. The MaxRecordCount can also be changed by modifying the MaxRecordCount XML tag in the MapServer's configuration file.

Product Availability

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

Method Summary

void	add(IMapServerFindResult findResult) Adds a find result.
int	getCount() The find result count.
IMapServerFindResult	getElement(int index) The find result at the specified position.
void	insert(int index, IMapServerFindResult findResult) Adds a find result at the specified position.
void	remove(int index) Removes the find result at the specified position.
void	removeAll() Removes all find results.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The find result count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IMapServerFindResult getElement(int index)
                                throws IOException,
                                       AutomationException

The find result at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IMapServerFindResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the find result at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all find results.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IMapServerFindResult findResult)
         throws IOException,
                AutomationException

Adds a find result.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

findResult - A reference to a com.esri.arcgis.carto.IMapServerFindResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerFindResult findResult)
            throws IOException,
                   AutomationException

Adds a find result at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

findResult - A reference to a com.esri.arcgis.carto.IMapServerFindResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.