com.esri.arcgis.geodatabase
Interface ILocatorWorkspaceName

All Superinterfaces:
Serializable
All Known Subinterfaces:
ILocatorWorkspaceName2
All Known Implementing Classes:
LocatorWorkspaceName

public interface ILocatorWorkspaceName
extends Serializable

Provides access to members that describe a locator workspace.

Superseded By

ILocatorWorkspaceName2

When To Use

Use the ILocatorWorkspaceName interface to get information that describes a locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorWorkspace2, ILocatorManager2, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName

Method Summary
 String getPath()
          The path to the folder that contains the locator workspace.
 int getType()
          The type of locator workspace.
 IWorkspaceName getWorkspaceName()
          The Name object for the ArcSDE workspace that contains the locator workspace.
 void setPath(String path)
          The path to the folder that contains the locator workspace.
 void setWorkspaceNameByRef(IWorkspaceName wksName)
          The Name object for the ArcSDE workspace that contains the locator workspace.
 

Method Detail

getPath

String getPath()
               throws IOException,
                      AutomationException
The path to the folder that contains the locator workspace.

Remarks

If the locator workspace represented by the LocatorWorkspaceName object is a file system locator workspace, then the Path property returns the path to the file system folder that contains the locator workspace. The value returned by the Path property depends on the value returned by the Type property, as shown in the following table:

If the value of the Type property is: then the Path property returns:
esriLocalSystemLocatorWorkspace an empty string
esriFileSystemLocatorWorkspace the path to the file system folder that contains the locator workspace

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPath

void setPath(String path)
             throws IOException,
                    AutomationException
The path to the folder that contains the locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getWorkspaceName

IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException
The Name object for the ArcSDE workspace that contains the locator workspace.

Remarks

The WorkspaceName property returns a WorkspaceName object that represents the ArcSDE workspace that contains the locator workspace represented by the LocatorWorkspaceName object. Use the Type property to determine if the locator workspace is an ArcSDE locator workspace before using this property.

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

setWorkspaceNameByRef

void setWorkspaceNameByRef(IWorkspaceName wksName)
                           throws IOException,
                                  AutomationException
The Name object for the ArcSDE workspace that contains the locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getType

int getType()
            throws IOException,
                   AutomationException
The type of locator workspace.

Description

The Type property returns a value from the esriLocatorWorkspaceType enumeration that indicates the type of locator workspace that the LocatorWorkspaceName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriLocatorWorkspaceType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspaceName.getType(), esriLocatorWorkspaceType