com.esri.arcgis.geodatabase
Interface IPlugInFileOperationsClass

All Superinterfaces:

Serializable

All Known Implementing Classes:

IPlugInFileOperationsClassProxy

public interface IPlugInFileOperationsClass
extends Serializable

Provides access to members for copying, deleting and renaming classes in a dataset helper.

Description

A plug-in dataset helper can implement IPlugInFileOperationsClass to support copy, rename and delete for feature classes within a feature dataset.

Remarks

If your implementation does not support one of Copy, Rename or Delete, be sure to return E_NOTIMPL from the method, as the ArcGIS framework does not guarantee calling CanCopy, CanRename or CanDelete before these methods.

Product Availability

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

Method Summary

boolean	canCopy(int classIndex) True if this dataset can be copied.
boolean	canDelete(int classIndex) True if this dataset can be deleted.
boolean	canRename(int classIndex) True if this dataset can be renamed.
void	copy(int classIndex, String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
void	delete(int classIndex) Deletes this dataset.
String	rename(int classIndex, String name) Renames this dataset.

Method Detail

canCopy

boolean canCopy(int classIndex)
                throws IOException,
                       AutomationException

True if this dataset can be copied.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

Returns:

The canCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

void copy(int classIndex,
          String copyName,
          IWorkspace copyWorkspace)
          throws IOException,
                 AutomationException

Copies this dataset to a new dataset with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

copyName - The copyName (in)

copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDelete

boolean canDelete(int classIndex)
                  throws IOException,
                         AutomationException

True if this dataset can be deleted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

Returns:

The canDelete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(int classIndex)
            throws IOException,
                   AutomationException

Deletes this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRename

boolean canRename(int classIndex)
                  throws IOException,
                         AutomationException

True if this dataset can be renamed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

Returns:

The canRename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

String rename(int classIndex,
              String name)
              throws IOException,
                     AutomationException

Renames this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

classIndex - The classIndex (in)

name - The name (in)

Returns:

The newName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.