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

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

All Implemented Interfaces:

GPTool

public class RegisterAsVersioned
extends AbstractGPTool

Registers ArcSDE data as The Register As Versioned tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:

• File and personal geodatabases; don't support versioning. Versioning tools only work with ArcSDE data.
• Registering a feature dataset as versioned registers all feature classes within the feature dataset as versioned.
• Versions are not affected by changes occurring in other versions of the database.
• A version's permission can only be changed by its owner.
• Making a feature class or table multiversioned requires a unique integer field. This is typically the OBJECTID field.
• Versions cannot be created or edited in ArcView.
• Learn more about saving edits to a version;
• Learn more about versioning;
• Learn more about registering and unregistering data as versioned;
• Learn about versioning scenarios;
• The following environment settings affect this tool: workspace; scratch workspace; , and output CONFIG keyword;

Field Summary

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

vals

Constructor Summary

RegisterAsVersioned()
Creates the Register As Versioned tool with defaults.

RegisterAsVersioned(Object inDataset)
Creates the Register As Versioned tool with the required parameters.

Method Summary

String	getEditToBase() Returns the Register the selected objects with the option to move edits to base parameter of this tool .
Object	getInDataset() Returns the Input Dataset parameter of this tool .
Object	getOutDataset() Returns the Output Dataset 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	setEditToBase(String editToBase) Sets the Register the selected objects with the option to move edits to base parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Dataset 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

RegisterAsVersioned

public RegisterAsVersioned()

Creates the Register As Versioned tool with defaults.

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

RegisterAsVersioned

public RegisterAsVersioned(Object inDataset)

Creates the Register As Versioned 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:

inDataset - Table View | Feature Dataset, name of the dataset to be registered as versioned.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is Table View | Feature Dataset, name of the dataset to be registered as versioned. This is a required parameter.

Returns:

the Input Dataset

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Dataset parameter of this tool . This parameter is Table View | Feature Dataset, name of the dataset to be registered as versioned. This is a required parameter.

Parameters:

inDataset - Table View | Feature Dataset, name of the dataset to be registered as versioned.

getEditToBase

public String getEditToBase()

Returns the Register the selected objects with the option to move edits to base parameter of this tool . This parameter is String, determines whether edits will be moved to the base tables (original tables). This is an optional parameter.

Returns:

the Register the selected objects with the option to move edits to base

setEditToBase

public void setEditToBase(String editToBase)

Sets the Register the selected objects with the option to move edits to base parameter of this tool . This parameter is String, determines whether edits will be moved to the base tables (original tables). This is an optional parameter.

Parameters:

editToBase - String, determines whether edits will be moved to the base tables (original tables).

getOutDataset

public Object getOutDataset()

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

Returns:

the Output Dataset

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