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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.ChangeVersion

All Implemented Interfaces:

GPTool

public class ChangeVersion
extends AbstractGPTool

Changes the version that an input feature layer or table view is connected to. This tool only changes the version for the input layer or table view - other layers or table views are not affected. The tool has no effect on the version you are connected to if using feature classes or tables. The Change Version tool is contained in the Data Management Tools tool box.

Usage tips:

• Only works with feature layers and table views.
• Each Feature Layer/Table View passed into the tool will have its workspace modified to connect to the requested version.
• The ArcSDE connection file used in the path to create the Feature Layer or Table View will not be edited by this tool. Only the open workspace of the Feature Layer/Table View is changed to connect to the specified version.
• Transactional and historical views are supported.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ChangeVersion()
Creates the Change Version tool with defaults.

ChangeVersion(Object inFeatures, String versionType)
Creates the Change Version tool with the required parameters.

Method Summary

Object	getDate() Returns the Date parameter of this tool .
Object	getInFeatures() Returns the Input Feature Layer parameter of this tool .
Object	getOutFeatureLayer() Returns the Output Feature Layer 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.
String	getVersionName() Returns the Version Name parameter of this tool .
String	getVersionType() Returns the Version Type parameter of this tool .
void	setDate(Object date) Sets the Date parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Feature Layer parameter of this tool .
void	setVersionName(String versionName) Sets the Version Name parameter of this tool .
void	setVersionType(String versionType) Sets the Version Type 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

ChangeVersion

public ChangeVersion()

Creates the Change Version tool with defaults.

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

ChangeVersion

public ChangeVersion(Object inFeatures,
                     String versionType)

Creates the Change 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:

inFeatures - the Input Feature Layer or Table View to connect to using the specified version.

versionType - the type of version to change to.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Feature Layer parameter of this tool . This parameter is the Input Feature Layer or Table View to connect to using the specified version. This is a required parameter.

Returns:

the Input Feature Layer

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Feature Layer parameter of this tool . This parameter is the Input Feature Layer or Table View to connect to using the specified version. This is a required parameter.

Parameters:

inFeatures - the Input Feature Layer or Table View to connect to using the specified version.

getVersionType

public String getVersionType()

Returns the Version Type parameter of this tool . This parameter is the type of version to change to. This is a required parameter.

Returns:

the Version Type

setVersionType

public void setVersionType(String versionType)

Sets the Version Type parameter of this tool . This parameter is the type of version to change to. This is a required parameter.

Parameters:

versionType - the type of version to change to.

getVersionName

public String getVersionName()

Returns the Version Name parameter of this tool . This parameter is name of the version to change to. Optional if using historical versions. This is an optional parameter.

Returns:

the Version Name

setVersionName

public void setVersionName(String versionName)

Sets the Version Name parameter of this tool . This parameter is name of the version to change to. Optional if using historical versions. This is an optional parameter.

Parameters:

versionName - name of the version to change to. Optional if using historical versions.

getDate

public Object getDate()

Returns the Date parameter of this tool . This parameter is date of the historical version to change to. This is an optional parameter.

Returns:

the Date

setDate

public void setDate(Object date)

Sets the Date parameter of this tool . This parameter is date of the historical version to change to. This is an optional parameter.

Parameters:

date - date of the historical version to change to.

getOutFeatureLayer

public Object getOutFeatureLayer()

Returns the Output Feature Layer parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Feature Layer

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