com.esri.arcgis.geodatabase
Interface ILocatorName

All Superinterfaces:
Serializable
All Known Implementing Classes:
LocatorName, RouteMeasureLocatorName

public interface ILocatorName
extends Serializable

Provides access to members that describe a locator.

When To Use

Use the ILocatorName interface to inspect the properties of a LocatorName object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorName, LocatorName, ILocatorWorkspace.getLocatorName(String)

Method Summary
 String getCategory()
          Category of the locator.
 String getDescription()
          Description of the locator.
 ILocatorWorkspaceName getLocatorWorkspaceName()
          Name object for the locator workspace that contains the locator.
 String getName()
          Name of the locator.
 boolean isStyle()
          Indicates if this is a locator style.
 void setCategory(String category)
          Category of the locator.
 void setDescription(String description)
          Description of the locator.
 void setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName)
          Name object for the locator workspace that contains the locator.
 void setName(String name)
          Name of the locator.
 void setStyle(boolean isStyle)
          Indicates if this is a locator style.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the locator.

Description

The Name property returns the name of the locator or locator style that the LocatorName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description of the locator.

Description

The Description property returns the description of the locator or locator style that the LocatorName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException
Description of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCategory

String getCategory()
                   throws IOException,
                          AutomationException
Category of the locator.

Description

The Category property returns the category of the locator or locator style represented by the LocatorName object.

Remarks

By default, address locator styles provided with ArcGIS, and address locators based on those locator styles, have a category of "Address".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.getLocatorNames(int, String), ILocatorName.getCategory(), ILocatorWorkspace.getLocators(int, String)

setCategory

void setCategory(String category)
                 throws IOException,
                        AutomationException
Category of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isStyle

boolean isStyle()
                throws IOException,
                       AutomationException
Indicates if this is a locator style.

Description

The Style property indicates if the LocatorName object represents a locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStyle

void setStyle(boolean isStyle)
              throws IOException,
                     AutomationException
Indicates if this is a locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLocatorWorkspaceName

ILocatorWorkspaceName getLocatorWorkspaceName()
                                              throws IOException,
                                                     AutomationException
Name object for the locator workspace that contains the locator.

Description

The LocatorWorkspaceName property returns the LocatorWorkspaceName object that represents the locator workspace that contains the locator or locator style represented by the LocatorName object.

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.ILocatorWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocatorWorkspaceNameByRef

void setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName)
                                  throws IOException,
                                         AutomationException
Name object for the locator workspace that contains the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
locatorWorkspaceName - A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.