com.esri.arcgis.location
Interface IGeocodeServerObjects

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeocodeServer

public interface IGeocodeServerObjects
extends Serializable

Provides access to the objects used by the geocode server.

Remarks

This interface is available only if the GeocodeServer was obtained for use in a stateful manner (i.e., either by co-creating the GeocodeServer object or by obtaining a reference using a GISServerConnection object.)

When To Use

Use the IGeocodeServerObjects interface to obtain a reference to the address locator that performs the geocoding functionality of the GeocodeServer.

Product Availability

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

Method Summary

ILocator

getAddressLocator() The address locator used by the geocode server.

Method Detail

getAddressLocator

ILocator getAddressLocator()
                           throws IOException,
                                  AutomationException

The address locator used by the geocode server.

Remarks

This IGeocodeServerObjects interface is available only if the GeocodeServer was obtained for use in a stateful manner (i.e., either by co-creating the GeocodeServer object or by obtaining a reference using a GISServerConnection object.)

The following example illustrates how to obtain a reference to the address locator that provides the geocoding functionality for a GeocodeServer:

    Dim pGISServerConnection As esriServer.IGISServerConnection

    Dim pServerObjectManager As esriServer.IServerObjectManager

    Dim pServerContext As esriServer.IServerContext

    Dim pGeocodeServerObjects As esriLocation.IGeocodeServerObjects

    Dim pLocator As esriGeoDatabase.ILocator



    '+++ connect to an ArcGIS Server and get the server object manager

    Set pGISServerConnection = New esriServer.GISServerConnection

    pGISServerConnection.Connect ("napanee")

    Set pServerObjectManager = pGISServerConnection.ServerObjectManager



    '+++ get a GeocodeServer object from its server context

    Set pServerContext = pServerObjectManager.CreateServerContext("RedlandsStreets", "GeocodeServer")

    Set pGeocodeServerObjects = pServerContext.ServerObject



    '+++ get the address locator from the GeocodeServer

    Set pLocator = pGeocodeServerObjects.AddressLocator



    '+++ release the server context after completing work with the GeocodeServer

    pServerContext.ReleaseContext

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ILocator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.