com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class DeleteVersion

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.DeleteVersion

All Implemented Interfaces:

GPTool

public class DeleteVersion
extends AbstractGPTool

Deletes the specified version from the input workspace. The Delete Version tool is contained in the Data Management Tools tool box.

Usage tips:

• Only the version's owner can rename, delete, or alter the version.
• A parent version cannot be deleted until all dependent child versions are deleted.
• Versions are not affected by changes occurring in other versions of the database.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

DeleteVersion()
Creates the Delete Version tool with defaults.

DeleteVersion(Object inWorkspace, String versionName)
Creates the Delete Version tool with the required parameters.

Method Summary

Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getVersionName() Returns the Version Name parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setVersionName(String versionName) Sets the Version Name parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteVersion

public DeleteVersion()

Creates the Delete Version tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

DeleteVersion

public DeleteVersion(Object inWorkspace,
                     String versionName)

Creates the Delete Version tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inWorkspace - the ArcSDE geodatabase containing the version to be deleted. The default is to use the workspace defined in the Current Workspace environment.

versionName - the name of the version to be deleted.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the ArcSDE geodatabase containing the version to be deleted. The default is to use the workspace defined in the Current Workspace environment. This is a required parameter.

Returns:

the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Workspace parameter of this tool . This parameter is the ArcSDE geodatabase containing the version to be deleted. The default is to use the workspace defined in the Current Workspace environment. This is a required parameter.

Parameters:

inWorkspace - the ArcSDE geodatabase containing the version to be deleted. The default is to use the workspace defined in the Current Workspace environment.

getVersionName

public String getVersionName()

Returns the Version Name parameter of this tool . This parameter is the name of the version to be deleted. This is a required parameter.

Returns:

the Version Name

setVersionName

public void setVersionName(String versionName)

Sets the Version Name parameter of this tool . This parameter is the name of the version to be deleted. This is a required parameter.

Parameters:

versionName - the name of the version to be deleted.

getOutWorkspace

public Object getOutWorkspace()

Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Workspace

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias