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

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

public class DeleteRasterCatalogItems
extends AbstractGPTool

Deletes raster catalog items, including all its contents, or a subset of its contents if there is a selection. The Delete Raster Catalog Items 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
DeleteRasterCatalogItems()
          Creates the Delete Raster Catalog Items tool with defaults.
DeleteRasterCatalogItems(Object inRasterCatalog)
          Creates the Delete Raster Catalog Items tool with the required parameters.
 
Method Summary
 Object getInRasterCatalog()
          Returns the Input Raster Catalog parameter of this tool .
 Object getOutRasterCatalog()
          Returns the Output Raster Catalog 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 setInRasterCatalog(Object inRasterCatalog)
          Sets the Input Raster Catalog 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

DeleteRasterCatalogItems

public DeleteRasterCatalogItems()
Creates the Delete Raster Catalog Items tool with defaults.

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


DeleteRasterCatalogItems

public DeleteRasterCatalogItems(Object inRasterCatalog)
Creates the Delete Raster Catalog Items 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:
inRasterCatalog - Raster catalog layer, the raster catalog to empty.
Method Detail

getInRasterCatalog

public Object getInRasterCatalog()
Returns the Input Raster Catalog parameter of this tool . This parameter is Raster catalog layer, the raster catalog to empty. This is a required parameter.

Returns:
the Input Raster Catalog

setInRasterCatalog

public void setInRasterCatalog(Object inRasterCatalog)
Sets the Input Raster Catalog parameter of this tool . This parameter is Raster catalog layer, the raster catalog to empty. This is a required parameter.

Parameters:
inRasterCatalog - Raster catalog layer, the raster catalog to empty.

getOutRasterCatalog

public Object getOutRasterCatalog()
Returns the Output Raster Catalog parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Raster Catalog

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