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

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

All Implemented Interfaces:

GPTool

public class ReconcileVersion
extends AbstractGPTool

Reconciles a version against a another version in its lineage. The Reconcile Version tool is contained in the Data Management Tools tool box.

Usage tips:

• The reconcile process requires that you are the only user currently editing the version and the only user able to edit the version throughout the reconcile process until you save or post.
• The reconcile process requires that you have full permissions to all the feature classes that have been modified in the version being edited.
• Versioning tools only work with ArcSDE data. File and Personal geodatabases don't support versioning.
• The geodatabase is designed to efficiently manage and support long transactions using versions.
• The reconcile process detects differences between the edit version and the target version and flags these differences as conflicts. If conflicts exist, they should be resolved.

Field Summary

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

vals

Constructor Summary

ReconcileVersion()
Creates the Reconcile Version tool with defaults.

ReconcileVersion(Object inWorkspace, String versionName, String targetName)
Creates the Reconcile Version tool with the required parameters.

Method Summary

String	getAbortIfConflicts() Returns the Abort if conflicts parameter of this tool .
String	getAquiredLocks() Returns the Aquire locks during reconcile parameter of this tool .
String	getConflictDefinition() Returns the Conflict Definition parameter of this tool .
String	getConflictResolution() Returns the Conflict Resolution 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	getPost() Returns the Post version after reconcile parameter of this tool .
String	getTargetName() Returns the Target 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	setAbortIfConflicts(String abortIfConflicts) Sets the Abort if conflicts parameter of this tool .
void	setAquiredLocks(String aquiredLocks) Sets the Aquire locks during reconcile parameter of this tool .
void	setConflictDefinition(String conflictDefinition) Sets the Conflict Definition parameter of this tool .
void	setConflictResolution(String conflictResolution) Sets the Conflict Resolution parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Workspace parameter of this tool .
void	setPost(String post) Sets the Post version after reconcile parameter of this tool .
void	setTargetName(String targetName) Sets the Target 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

ReconcileVersion

public ReconcileVersion()

Creates the Reconcile Version tool with defaults.

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

ReconcileVersion

public ReconcileVersion(Object inWorkspace,
                        String versionName,
                        String targetName)

Creates the Reconcile 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 containing the reconcilable version. The default is to use the workspace defined in the environment.

versionName - name of the Edit Version to be reconciled with the Target Version.

targetName - name of any version in the direct ancestry of the Edit version, such as the parent version or the default version.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Workspace parameter of this tool . This parameter is the ArcSDE geodatabase containing the reconcilable version. The default is to use the workspace defined in the environment. 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 containing the reconcilable version. The default is to use the workspace defined in the environment. This is a required parameter.

Parameters:

inWorkspace - the ArcSDE geodatabase containing the reconcilable version. The default is to use the workspace defined in the environment.

getVersionName

public String getVersionName()

Returns the Version Name parameter of this tool . This parameter is name of the Edit Version to be reconciled with the Target Version. 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 name of the Edit Version to be reconciled with the Target Version. This is a required parameter.

Parameters:

versionName - name of the Edit Version to be reconciled with the Target Version.

getTargetName

public String getTargetName()

Returns the Target Version parameter of this tool . This parameter is name of any version in the direct ancestry of the Edit version, such as the parent version or the default version. This is a required parameter.

Returns:

the Target Version

setTargetName

public void setTargetName(String targetName)

Sets the Target Version parameter of this tool . This parameter is name of any version in the direct ancestry of the Edit version, such as the parent version or the default version. This is a required parameter.

Parameters:

targetName - name of any version in the direct ancestry of the Edit version, such as the parent version or the default version.

getConflictDefinition

public String getConflictDefinition()

Returns the Conflict Definition parameter of this tool . This parameter is describes the conditions required for a conflict to occur: This is an optional parameter.

Returns:

the Conflict Definition

setConflictDefinition

public void setConflictDefinition(String conflictDefinition)

Sets the Conflict Definition parameter of this tool . This parameter is describes the conditions required for a conflict to occur: This is an optional parameter.

Parameters:

conflictDefinition - describes the conditions required for a conflict to occur:

getConflictResolution

public String getConflictResolution()

Returns the Conflict Resolution parameter of this tool . This parameter is describes the behavior if a conflict is detected: This is an optional parameter.

Returns:

the Conflict Resolution

setConflictResolution

public void setConflictResolution(String conflictResolution)

Sets the Conflict Resolution parameter of this tool . This parameter is describes the behavior if a conflict is detected: This is an optional parameter.

Parameters:

conflictResolution - describes the behavior if a conflict is detected:

getAquiredLocks

public String getAquiredLocks()

Returns the Aquire locks during reconcile parameter of this tool . This is an optional parameter.

Returns:

the Aquire locks during reconcile

setAquiredLocks

public void setAquiredLocks(String aquiredLocks)

Sets the Aquire locks during reconcile parameter of this tool . This is an optional parameter.

Parameters:

aquiredLocks - null

getAbortIfConflicts

public String getAbortIfConflicts()

Returns the Abort if conflicts parameter of this tool . This parameter is determines if the reconcile process should be aborted if conflicts are found between the target version and the edit version. This is an optional parameter.

Returns:

the Abort if conflicts

setAbortIfConflicts

public void setAbortIfConflicts(String abortIfConflicts)

Sets the Abort if conflicts parameter of this tool . This parameter is determines if the reconcile process should be aborted if conflicts are found between the target version and the edit version. This is an optional parameter.

Parameters:

abortIfConflicts - determines if the reconcile process should be aborted if conflicts are found between the target version and the edit version.

getPost

public String getPost()

Returns the Post version after reconcile parameter of this tool . This parameter is posts the current edit session to the reconciled target version. This is an optional parameter.

Returns:

the Post version after reconcile

setPost

public void setPost(String post)

Sets the Post version after reconcile parameter of this tool . This parameter is posts the current edit session to the reconciled target version. This is an optional parameter.

Parameters:

post - posts the current edit session to the reconciled target 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