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

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

All Implemented Interfaces:

GPTool

public class CreateVersion
extends AbstractGPTool

Creates a new version in the specified geodatabase. The Create Version tool is contained in the Data Management Tools tool box.

Usage tips:

• The output version name is prefixed by the SDE geodatabase user name—for example, SDE.arctoolbox.
• The output version's permissions are set to private by default but can be changed using the tool.
• Personal and File geodatabases do not support versioning. Versioning tools only work with ArcSDE geodatabases.
• Versions are not affected by changes occurring in other versions of the database.
• A version's permission can only be changed by its owner (the user who created it).

Field Summary

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

vals

Constructor Summary

CreateVersion()
Creates the Create Version tool with defaults.

CreateVersion(Object inWorkspace, String parentVersion, String versionName)
Creates the Create Version tool with the required parameters.

Method Summary

String	getAccessPermission() Returns the Access Permission parameter of this tool .
Object	getInWorkspace() Returns the Input Workspace parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace parameter of this tool (Read only).
String	getParentVersion() Returns the Parent Version 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.
String	getVersionName() Returns the Version Name parameter of this tool .
void	setAccessPermission(String accessPermission) Sets the Access Permission parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setParentVersion(String parentVersion) Sets the Parent Version parameter of this tool .
void	setVersionName(String versionName) 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

CreateVersion

public CreateVersion()

Creates the Create Version tool with defaults.

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

CreateVersion

public CreateVersion(Object inWorkspace,
                     String parentVersion,
                     String versionName)

Creates the Create 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 - the ArcSDE geodatabase that contains the parent version and will contain the new version. The default is to use the workspace defined in the environment settings.

parentVersion - the geodatabase, or version of a geodatabase, on which the new version will be based.

versionName - the name of the version to be created.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the ArcSDE geodatabase that contains the parent version and will contain the new version. The default is to use the workspace defined in the environment settings. 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 the ArcSDE geodatabase that contains the parent version and will contain the new version. The default is to use the workspace defined in the environment settings. This is a required parameter.

Parameters:

inWorkspace - the ArcSDE geodatabase that contains the parent version and will contain the new version. The default is to use the workspace defined in the environment settings.

getParentVersion

public String getParentVersion()

Returns the Parent Version parameter of this tool . This parameter is the geodatabase, or version of a geodatabase, on which the new version will be based. This is a required parameter.

Returns:

the Parent Version

setParentVersion

public void setParentVersion(String parentVersion)

Sets the Parent Version parameter of this tool . This parameter is the geodatabase, or version of a geodatabase, on which the new version will be based. This is a required parameter.

Parameters:

parentVersion - the geodatabase, or version of a geodatabase, on which the new version will be based.

getVersionName

public String getVersionName()

Returns the Version Name parameter of this tool . This parameter is the name of the version to be created. This is a required parameter.

Returns:

the Version Name

setVersionName

public void setVersionName(String versionName)

Sets the Version Name parameter of this tool . This parameter is the name of the version to be created. This is a required parameter.

Parameters:

versionName - the name of the version to be created.

getAccessPermission

public String getAccessPermission()

Returns the Access Permission parameter of this tool . This parameter is the permission access level for the version. This is an optional parameter.

Returns:

the Access Permission

setAccessPermission

public void setAccessPermission(String accessPermission)

Sets the Access Permission parameter of this tool . This parameter is the permission access level for the version. This is an optional parameter.

Parameters:

accessPermission - the permission access level for the version.

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