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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.Checkin
All Implemented Interfaces:
GPTool

public class Checkin
extends AbstractGPTool

Synchronizes changes from a check-out replica in an ArcSDE, file, or personal geodatabase to the parent ArcSDE The Check In tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Checkin()
          Creates the Check In tool with defaults.
Checkin(Object inWorkspace, Object destWorkspace)
          Creates the Check In tool with the required parameters.
 
Method Summary
 Object getDestWorkspace()
          Returns the Check-in to Workspace parameter of this tool .
 Object getInWorkspace()
          Returns the Check-in from Workspace parameter of this tool .
 Object getOutputWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 String getReconcile()
          Returns the Reconcile with the Parent Versioin 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 setDestWorkspace(Object destWorkspace)
          Sets the Check-in to Workspace parameter of this tool .
 void setInWorkspace(Object inWorkspace)
          Sets the Check-in from Workspace parameter of this tool .
 void setReconcile(String reconcile)
          Sets the Reconcile with the Parent Versioin 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

Checkin

public Checkin()
Creates the Check In tool with defaults.

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


Checkin

public Checkin(Object inWorkspace,
               Object destWorkspace)
Creates the Check In 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 - Workspace, that contains the child replica. This can be an ArcSDE, file, or personal geodatabase.
destWorkspace - Workspace, the parent replica geodatabase. The ArcSDE workspace to which changes will be applied.
Method Detail

getInWorkspace

public Object getInWorkspace()
Returns the Check-in from Workspace parameter of this tool . This parameter is Workspace, that contains the child replica. This can be an ArcSDE, file, or personal geodatabase. This is a required parameter.

Returns:
the Check-in from Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)
Sets the Check-in from Workspace parameter of this tool . This parameter is Workspace, that contains the child replica. This can be an ArcSDE, file, or personal geodatabase. This is a required parameter.

Parameters:
inWorkspace - Workspace, that contains the child replica. This can be an ArcSDE, file, or personal geodatabase.

getDestWorkspace

public Object getDestWorkspace()
Returns the Check-in to Workspace parameter of this tool . This parameter is Workspace, the parent replica geodatabase. The ArcSDE workspace to which changes will be applied. This is a required parameter.

Returns:
the Check-in to Workspace

setDestWorkspace

public void setDestWorkspace(Object destWorkspace)
Sets the Check-in to Workspace parameter of this tool . This parameter is Workspace, the parent replica geodatabase. The ArcSDE workspace to which changes will be applied. This is a required parameter.

Parameters:
destWorkspace - Workspace, the parent replica geodatabase. The ArcSDE workspace to which changes will be applied.

getReconcile

public String getReconcile()
Returns the Reconcile with the Parent Versioin parameter of this tool . This parameter is String, after the edits have been synchronized. This is an optional parameter.

Returns:
the Reconcile with the Parent Versioin

setReconcile

public void setReconcile(String reconcile)
Sets the Reconcile with the Parent Versioin parameter of this tool . This parameter is String, after the edits have been synchronized. This is an optional parameter.

Parameters:
reconcile - String, after the edits have been synchronized.

getOutputWorkspace

public Object getOutputWorkspace()
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