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

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

public class ClearWorkspaceCache
extends AbstractGPTool

Clears any ArcSDE workspaces from the ArcSDE workspace cache. The Clear Workspace Cache 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
ClearWorkspaceCache()
          Creates the Clear Workspace Cache tool with defaults.
 
Method Summary
 Object getInData()
          Returns the Input data element parameter of this tool .
 String getOutResults()
          Returns the Operation 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 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

ClearWorkspaceCache

public ClearWorkspaceCache()
Creates the Clear Workspace Cache tool with defaults.

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

Method Detail

getInData

public Object getInData()
Returns the Input data element parameter of this tool . This parameter is ArcSDE connection file, connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input paramter will clear all ArcSDE workspaces from the cache. This is an optional parameter.

Returns:
the Input data element

setInData

public void setInData(Object inData)
Sets the Input data element parameter of this tool . This parameter is ArcSDE connection file, connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input paramter will clear all ArcSDE workspaces from the cache. This is an optional parameter.

Parameters:
inData - ArcSDE connection file, connection file representing the ArcSDE workspace to be removed from the cache. Specify the path to the ArcSDE connection file that was used in running your geoprocessing tools in order to remove the specific ArcSDE workspace from the cache. Passing no input paramter will clear all ArcSDE workspaces from the cache.

getOutResults

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

Returns:
the Operation 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