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

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

All Implemented Interfaces:

GPTool

public class SynchronizeChanges
extends AbstractGPTool

Synchronizes updates between two replica geodatabases in a direction specified by the user. The Synchronize Changes tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is used when synchronizing replicas in connected mode. To synchronize replicas in disconnected mode see the , , and tools.
• Two-way, one-way, and check-out replicas can be synchronized with this tool.
• The replica geodatabases can be local geodatabases or geodata services.
• Once synchronized, the changes (edits) will be reflected in the target geodatabase and viewable by all users.

Field Summary

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

vals

Constructor Summary

SynchronizeChanges()
Creates the Synchronize Changes tool with defaults.

SynchronizeChanges(Object geodatabase1, String inReplica, Object geodatabase2, String inDirection, String conflictPolicy, String conflictDefinition, String reconcile)
Creates the Synchronize Changes tool with the required parameters.

Method Summary

String	getConflictDefinition() Returns the Conflict Definition parameter of this tool .
String	getConflictPolicy() Returns the Conflict Resolution Policy parameter of this tool .
Object	getGeodatabase1() Returns the Geodatabase 1 parameter of this tool .
Object	getGeodatabase2() Returns the Geodatabase 2 parameter of this tool .
String	getInDirection() Returns the Direction parameter of this tool .
String	getInReplica() Returns the Replica parameter of this tool .
Object	getOutGeodatabase1() Returns the Output Geodatabase 1 parameter of this tool (Read only).
Object	getOutGeodatabase2() Returns the Output Geodatabase 2 parameter of this tool (Read only).
String	getReconcile() Returns the Reconcile with the Parent Version (Single Generation only) 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.
void	setConflictDefinition(String conflictDefinition) Sets the Conflict Definition parameter of this tool .
void	setConflictPolicy(String conflictPolicy) Sets the Conflict Resolution Policy parameter of this tool .
void	setGeodatabase1(Object geodatabase1) Sets the Geodatabase 1 parameter of this tool .
void	setGeodatabase2(Object geodatabase2) Sets the Geodatabase 2 parameter of this tool .
void	setInDirection(String inDirection) Sets the Direction parameter of this tool .
void	setInReplica(String inReplica) Sets the Replica parameter of this tool .
void	setReconcile(String reconcile) Sets the Reconcile with the Parent Version (Single Generation only) 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

SynchronizeChanges

public SynchronizeChanges()

Creates the Synchronize Changes tool with defaults.

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

SynchronizeChanges

public SynchronizeChanges(Object geodatabase1,
                          String inReplica,
                          Object geodatabase2,
                          String inDirection,
                          String conflictPolicy,
                          String conflictDefinition,
                          String reconcile)

Creates the Synchronize Changes 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:

geodatabase1 - the geodatabase hosting the replica to synchronize. The geodatabase may be local or remote.

inReplica - a valid replica with a parent contained within one input geodatabase and a child in the other input geodatabase.

geodatabase2 - the geodatabase hosting the relative replica. The geodatabase may be local or remote.

inDirection - the direction in which you want changes to be sent: from geodatabase 1 to geodatabase 2, from geodatabase 2 to geodatabase 1, or to send changes in both directions. For check-out/check-in replicas or one-way replicas there is only one appropriate direction. If the replica is two-way then any of the three choices are available.

conflictPolicy - specifies how conflicts are resolved when they are encountered.

conflictDefinition - specifies how you would like to define conflicts:

reconcile - indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas.

Method Detail

getGeodatabase1

public Object getGeodatabase1()

Returns the Geodatabase 1 parameter of this tool . This parameter is the geodatabase hosting the replica to synchronize. The geodatabase may be local or remote. This is a required parameter.

Returns:

the Geodatabase 1

setGeodatabase1

public void setGeodatabase1(Object geodatabase1)

Sets the Geodatabase 1 parameter of this tool . This parameter is the geodatabase hosting the replica to synchronize. The geodatabase may be local or remote. This is a required parameter.

Parameters:

geodatabase1 - the geodatabase hosting the replica to synchronize. The geodatabase may be local or remote.

getInReplica

public String getInReplica()

Returns the Replica parameter of this tool . This parameter is a valid replica with a parent contained within one input geodatabase and a child in the other input geodatabase. This is a required parameter.

Returns:

the Replica

setInReplica

public void setInReplica(String inReplica)

Sets the Replica parameter of this tool . This parameter is a valid replica with a parent contained within one input geodatabase and a child in the other input geodatabase. This is a required parameter.

Parameters:

inReplica - a valid replica with a parent contained within one input geodatabase and a child in the other input geodatabase.

getGeodatabase2

public Object getGeodatabase2()

Returns the Geodatabase 2 parameter of this tool . This parameter is the geodatabase hosting the relative replica. The geodatabase may be local or remote. This is a required parameter.

Returns:

the Geodatabase 2

setGeodatabase2

public void setGeodatabase2(Object geodatabase2)

Sets the Geodatabase 2 parameter of this tool . This parameter is the geodatabase hosting the relative replica. The geodatabase may be local or remote. This is a required parameter.

Parameters:

geodatabase2 - the geodatabase hosting the relative replica. The geodatabase may be local or remote.

getInDirection

public String getInDirection()

Returns the Direction parameter of this tool . This parameter is the direction in which you want changes to be sent: from geodatabase 1 to geodatabase 2, from geodatabase 2 to geodatabase 1, or to send changes in both directions. For check-out/check-in replicas or one-way replicas there is only one appropriate direction. If the replica is two-way then any of the three choices are available. This is a required parameter.

Returns:

the Direction

setInDirection

public void setInDirection(String inDirection)

Sets the Direction parameter of this tool . This parameter is the direction in which you want changes to be sent: from geodatabase 1 to geodatabase 2, from geodatabase 2 to geodatabase 1, or to send changes in both directions. For check-out/check-in replicas or one-way replicas there is only one appropriate direction. If the replica is two-way then any of the three choices are available. This is a required parameter.

Parameters:

inDirection - the direction in which you want changes to be sent: from geodatabase 1 to geodatabase 2, from geodatabase 2 to geodatabase 1, or to send changes in both directions. For check-out/check-in replicas or one-way replicas there is only one appropriate direction. If the replica is two-way then any of the three choices are available.

getConflictPolicy

public String getConflictPolicy()

Returns the Conflict Resolution Policy parameter of this tool . This parameter is specifies how conflicts are resolved when they are encountered. This is a required parameter.

Returns:

the Conflict Resolution Policy

setConflictPolicy

public void setConflictPolicy(String conflictPolicy)

Sets the Conflict Resolution Policy parameter of this tool . This parameter is specifies how conflicts are resolved when they are encountered. This is a required parameter.

Parameters:

conflictPolicy - specifies how conflicts are resolved when they are encountered.

getConflictDefinition

public String getConflictDefinition()

Returns the Conflict Definition parameter of this tool . This parameter is specifies how you would like to define conflicts: This is a required parameter.

Returns:

the Conflict Definition

setConflictDefinition

public void setConflictDefinition(String conflictDefinition)

Sets the Conflict Definition parameter of this tool . This parameter is specifies how you would like to define conflicts: This is a required parameter.

Parameters:

conflictDefinition - specifies how you would like to define conflicts:

getReconcile

public String getReconcile()

Returns the Reconcile with the Parent Version (Single Generation only) parameter of this tool . This parameter is indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas. This is a required parameter.

Returns:

the Reconcile with the Parent Version (Single Generation only)

setReconcile

public void setReconcile(String reconcile)

Sets the Reconcile with the Parent Version (Single Generation only) parameter of this tool . This parameter is indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas. This is a required parameter.

Parameters:

reconcile - indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas.

getOutGeodatabase1

public Object getOutGeodatabase1()

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

Returns:

the Output Geodatabase 1

getOutGeodatabase2

public Object getOutGeodatabase2()

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

Returns:

the Output Geodatabase 2

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