com.esri.arcgis.geodatabase
Interface IPlugInFileOperations

All Superinterfaces:

Serializable

All Known Implementing Classes:

IPlugInFileOperationsProxy

public interface IPlugInFileOperations
extends Serializable

Provides access to members for copying, deleting and renaming the dataset helper.

Description

A plug-in dataset helper can implement IPlugInFileOperations to support copy, rename and delete for feature datasets, stand-alone tables or stand-alone feature classes.

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() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	copy(String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
void	delete() Deletes this dataset.
String	rename(String name) Renames this dataset.

Method Detail

canCopy

boolean canCopy()
                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

Returns:

The canCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

void copy(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:

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()
                  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

Returns:

The canDelete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete()
            throws IOException,
                   AutomationException

Deletes this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRename

boolean canRename()
                  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

Returns:

The canRename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

String rename(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:

name - The name (in)

Returns:

The newName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.