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

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

public class AlterVersion
extends AbstractGPTool

Alters the database version's properties of name, description, and access permissions. The Alter Version tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AlterVersion()
          Creates the Alter Version tool with defaults.
AlterVersion(Object inWorkspace, String inVersion)
          Creates the Alter Version tool with the required parameters.
 
Method Summary
 String getAccess()
          Returns the Access Permission parameter of this tool .
 String getDescription()
          Returns the Version Description parameter of this tool .
 String getInVersion()
          Returns the Input Version parameter of this tool .
 Object getInWorkspace()
          Returns the Input Workspace parameter of this tool .
 String getName()
          Returns the Version Name parameter of this tool .
 Object getOutWorkspace()
          Returns the Output Workspace 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 setAccess(String access)
          Sets the Access Permission parameter of this tool .
 void setDescription(String description)
          Sets the Version Description parameter of this tool .
 void setInVersion(String inVersion)
          Sets the Input Version parameter of this tool .
 void setInWorkspace(Object inWorkspace)
          Sets the Input Workspace parameter of this tool .
 void setName(String name)
          Sets the Version Name 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

AlterVersion

public AlterVersion()
Creates the Alter Version tool with defaults.

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


AlterVersion

public AlterVersion(Object inWorkspace,
                    String inVersion)
Creates the Alter Version 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:
inWorkspace - Workspace, to be altered is located.
inVersion - String, name of the version to be altered.
Method Detail

getInWorkspace

public Object getInWorkspace()
Returns the Input Workspace parameter of this tool . This parameter is Workspace, to be altered is located. This is a required parameter.

Returns:
the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)
Sets the Input Workspace parameter of this tool . This parameter is Workspace, to be altered is located. This is a required parameter.

Parameters:
inWorkspace - Workspace, to be altered is located.

getInVersion

public String getInVersion()
Returns the Input Version parameter of this tool . This parameter is String, name of the version to be altered. This is a required parameter.

Returns:
the Input Version

setInVersion

public void setInVersion(String inVersion)
Sets the Input Version parameter of this tool . This parameter is String, name of the version to be altered. This is a required parameter.

Parameters:
inVersion - String, name of the version to be altered.

getName

public String getName()
Returns the Version Name parameter of this tool . This parameter is String, the new name of the version. This is an optional parameter.

Returns:
the Version Name

setName

public void setName(String name)
Sets the Version Name parameter of this tool . This parameter is String, the new name of the version. This is an optional parameter.

Parameters:
name - String, the new name of the version.

getDescription

public String getDescription()
Returns the Version Description parameter of this tool . This parameter is String, the new description for the version. This is an optional parameter.

Returns:
the Version Description

setDescription

public void setDescription(String description)
Sets the Version Description parameter of this tool . This parameter is String, the new description for the version. This is an optional parameter.

Parameters:
description - String, the new description for the version.

getAccess

public String getAccess()
Returns the Access Permission parameter of this tool . This parameter is String, set/Change the access permissions. This is an optional parameter.

Returns:
the Access Permission

setAccess

public void setAccess(String access)
Sets the Access Permission parameter of this tool . This parameter is String, set/Change the access permissions. This is an optional parameter.

Parameters:
access - String, set/Change the access permissions.

getOutWorkspace

public Object getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Workspace

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