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

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

public class DeleteGlobeServerCache
extends AbstractGPTool

Deletes an existing Globe Service layer's cache. This is an unrecoverable operation so only use if you are sure you no longer need the cache. The Delete Globe 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
DeleteGlobeServerCache()
          Creates the Delete Globe Server Cache tool with defaults.
DeleteGlobeServerCache(String serverName, String objectName, Object layer)
          Creates the Delete Globe Server Cache tool with the required parameters.
 
Method Summary
 Object getLayer()
          Returns the Input Layers parameter of this tool .
 String getObjectName()
          Returns the GlobeServer Object parameter of this tool .
 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 setLayer(Object layer)
          Sets the Input Layers parameter of this tool .
 void setObjectName(String objectName)
          Sets the GlobeServer Object 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

DeleteGlobeServerCache

public DeleteGlobeServerCache()
Creates the Delete Globe Server Cache tool with defaults.

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


DeleteGlobeServerCache

public DeleteGlobeServerCache(String serverName,
                              String objectName,
                              Object layer)
Creates the Delete Globe 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 to use to update the cache.
objectName - String, the name of the Globe Service to use to update the cache.
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 to use to update the cache. 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 to use to update the cache. This is a required parameter.

Parameters:
serverName - String, the host name of the ArcGIS Server to use to update the cache.

getObjectName

public String getObjectName()
Returns the GlobeServer Object parameter of this tool . This parameter is String, the name of the Globe Service to use to update the cache. This is a required parameter.

Returns:
the GlobeServer Object

setObjectName

public void setObjectName(String objectName)
Sets the GlobeServer Object parameter of this tool . This parameter is String, the name of the Globe Service to use to update the cache. This is a required parameter.

Parameters:
objectName - String, the name of the Globe Service to use to update the cache.

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

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