com.esri.arcgis.location
Interface ILocatorEvents

All Superinterfaces:

Serializable

All Known Implementing Classes:

ILocatorEventsProxy

public interface ILocatorEvents
extends Serializable

Provides access to members to respond to locator management operations.

Description

The ILocatorEvents interface is implemented by all locators. ArcObjects applications call the methods on the ILocatorEvents interface when one of the following management functions is performed: Copy; Create; Delete; or Rename. The locator implements its specific behavior in response to these management operations. Typically, a LocatorWorkspace object will call methods on the ILocatorEvents interface.

Product Availability

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

Method Summary

void	onBuild(boolean rebuild, String tableName, String configKeyword, ITrackCancel pCancelTracker) Responds to the client building or rebuilding the locator.
void	onCopy(ILocatorWorkspace pNewLocWks, String newName, IPropertySet pNewProps, String configKeyword, ITrackCancel pCancelTracker) Responds to the client copying the locator.
void	onDelete(ITrackCancel pCancelTracker) Responds to the client deleting the locator.
void	onRename(String newName, ITrackCancel pCancelTracker) Responds to the client renaming the locator.

Method Detail

onBuild

void onBuild(boolean rebuild,
             String tableName,
             String configKeyword,
             ITrackCancel pCancelTracker)
             throws IOException,
                    AutomationException

Responds to the client building or rebuilding the locator.

Product Availability

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

Parameters:

rebuild - The rebuild (in)

tableName - The tableName (in)

configKeyword - The configKeyword (in)

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

void onDelete(ITrackCancel pCancelTracker)
              throws IOException,
                     AutomationException

Responds to the client deleting the locator.

Product Availability

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

Parameters:

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRename

void onRename(String newName,
              ITrackCancel pCancelTracker)
              throws IOException,
                     AutomationException

Responds to the client renaming the locator.

Product Availability

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

Parameters:

newName - The newName (in)

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCopy

void onCopy(ILocatorWorkspace pNewLocWks,
            String newName,
            IPropertySet pNewProps,
            String configKeyword,
            ITrackCancel pCancelTracker)
            throws IOException,
                   AutomationException

Responds to the client copying the locator.

Product Availability

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

Parameters:

pNewLocWks - A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspace (in)

newName - The newName (in)

pNewProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

configKeyword - The configKeyword (in)

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.