com.esri.arcgis.geoprocessing.tools.servertools
Class DeleteMapServerCache

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

public class DeleteMapServerCache
extends AbstractGPTool

Deletes an existing Map Service cache including all associated files on disk. This is an unrecoverable operation so only use if you are sure you no longer need the cache. The Delete Map Server Cache tool is contained in the Server Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DeleteMapServerCache()
          Creates the Delete Map Server Cache tool with defaults.
DeleteMapServerCache(String serverName, String objectName, String dataFrame, Object layer)
          Creates the Delete Map Server Cache tool with the required parameters.
 
Method Summary
 String getDataFrame()
          Returns the Data Frame parameter of this tool .
 Object getLayer()
          Returns the Input Layers parameter of this tool .
 String getObjectName()
          Returns the Map Server parameter of this tool .
 String getOutObjectName()
          Returns the Output Map Server parameter of this tool (Read only).
 String getOutServerName()
          Returns the Output Host parameter of this tool (Read only).
 String getServerName()
          Returns the Host parameter of this tool .
 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 setDataFrame(String dataFrame)
          Sets the Data Frame parameter of this tool .
 void setLayer(Object layer)
          Sets the Input Layers parameter of this tool .
 void setObjectName(String objectName)
          Sets the Map Server parameter of this tool .
 void setServerName(String serverName)
          Sets the Host 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

DeleteMapServerCache

public DeleteMapServerCache()
Creates the Delete Map Server Cache tool with defaults.

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


DeleteMapServerCache

public DeleteMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            Object layer)
Creates the Delete Map Server Cache 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:
serverName - String, the host name of the ArcGIS Server serving the cache to delete.
objectName - String, the name of the Map Service from which to delete the cache.
dataFrame - String, the map frame in the cache that will be deleted. This is here for informational purposes only and cannot be changed.
layer - null
Method Detail

getServerName

public String getServerName()
Returns the Host parameter of this tool . This parameter is String, the host name of the ArcGIS Server serving the cache to delete. This is a required parameter.

Returns:
the Host

setServerName

public void setServerName(String serverName)
Sets the Host parameter of this tool . This parameter is String, the host name of the ArcGIS Server serving the cache to delete. This is a required parameter.

Parameters:
serverName - String, the host name of the ArcGIS Server serving the cache to delete.

getObjectName

public String getObjectName()
Returns the Map Server parameter of this tool . This parameter is String, the name of the Map Service from which to delete the cache. This is a required parameter.

Returns:
the Map Server

setObjectName

public void setObjectName(String objectName)
Sets the Map Server parameter of this tool . This parameter is String, the name of the Map Service from which to delete the cache. This is a required parameter.

Parameters:
objectName - String, the name of the Map Service from which to delete the cache.

getDataFrame

public String getDataFrame()
Returns the Data Frame parameter of this tool . This parameter is String, the map frame in the cache that will be deleted. This is here for informational purposes only and cannot be changed. This is a required parameter.

Returns:
the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)
Sets the Data Frame parameter of this tool . This parameter is String, the map frame in the cache that will be deleted. This is here for informational purposes only and cannot be changed. This is a required parameter.

Parameters:
dataFrame - String, the map frame in the cache that will be deleted. This is here for informational purposes only and cannot be changed.

getLayer

public Object getLayer()
Returns the Input Layers parameter of this tool . This is a required parameter.

Returns:
the Input Layers

setLayer

public void setLayer(Object layer)
Sets the Input Layers parameter of this tool . This is a required parameter.

Parameters:
layer - null

getOutServerName

public String getOutServerName()
Returns the Output Host parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Host

getOutObjectName

public String getOutObjectName()
Returns the Output Map Server parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Map Server

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