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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.Delete
All Implemented Interfaces:
GPTool

public class Delete
extends AbstractGPTool

Permanently deletes data including data types such as The Delete tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Delete()
          Creates the Delete tool with defaults.
Delete(Object inData)
          Creates the Delete tool with the required parameters.
 
Method Summary
 String getDataType()
          Returns the Data type parameter of this tool .
 Object getInData()
          Returns the Input data element parameter of this tool .
 String getOutResults()
          Returns the Delete succeeded 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.
 void setDataType(String dataType)
          Sets the Data type parameter of this tool .
 void setInData(Object inData)
          Sets the Input data element 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

Delete

public Delete()
Creates the Delete tool with defaults.

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


Delete

public Delete(Object inData)
Creates the Delete 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:
inData - Data Element | Layer, the input data to be deleted.
Method Detail

getInData

public Object getInData()
Returns the Input data element parameter of this tool . This parameter is Data Element | Layer, the input data to be deleted. This is a required parameter.

Returns:
the Input data element

setInData

public void setInData(Object inData)
Sets the Input data element parameter of this tool . This parameter is Data Element | Layer, the input data to be deleted. This is a required parameter.

Parameters:
inData - Data Element | Layer, the input data to be deleted.

getDataType

public String getDataType()
Returns the Data type parameter of this tool . This parameter is String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class. This is an optional parameter.

Returns:
the Data type

setDataType

public void setDataType(String dataType)
Sets the Data type parameter of this tool . This parameter is String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class. This is an optional parameter.

Parameters:
dataType - String, this is the type of data being deleted. In the case where a geodatabase contains a feature dataset and a feature class with the same name, you may want to specify the type of data to be deleted. You would need to specify feature dataset or feature class.

getOutResults

public String getOutResults()
Returns the Delete succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:
the Delete succeeded

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