com.esri.arcgis.geodatabasedistributed
Interface ICheckIn

All Superinterfaces:
Serializable
All Known Subinterfaces:
ICheckIn2
All Known Implementing Classes:
CheckIn

public interface ICheckIn
extends Serializable

Provides access to members that perform a check in.

Superseded By

ICheckIn2

Remarks

The ICheckIn interface allows you to check changes into the parent replica (previously referred to as a checking in changes to the master geodatabase ) from either the check-out replica or a delta file. For control over how conflicts are detected and dealt with upon check in please refer to the ICheckin2 interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
ICheckIn.checkInFromGDB(com.esri.arcgis.geodatabase.IWorkspaceName, String, com.esri.arcgis.geodatabase.IWorkspaceName, boolean, boolean), ICheckIn, CheckIn

Method Summary
 boolean checkInFromDeltaFile(IWorkspaceName parentDB, String checkoutName, String fileName, int dcOption, boolean reconcileCheckout, boolean createOIDMappingTable)
          Checks in changes from a delta database.
 boolean checkInFromGDB(IWorkspaceName parentDB, String checkoutName, IWorkspaceName checkOutDB, boolean reconcileCheckout, boolean createOIDMappingTable)
          Checks in changes from a check-out database.
 

Method Detail

checkInFromGDB

boolean checkInFromGDB(IWorkspaceName parentDB,
                       String checkoutName,
                       IWorkspaceName checkOutDB,
                       boolean reconcileCheckout,
                       boolean createOIDMappingTable)
                       throws IOException,
                              AutomationException
Checks in changes from a check-out database.

Remarks

The CheckinfromGDB method applies the changes made in the checkOutDB (check-out geodatabase) to the parentDB (master geodatabase or parent replica) workspace.

The checkoutName is needed to identify the check-out that is being checked in.

If createOIDMappingTable is True, tables are created in the parent replica geodatabase that describe the changes that are checked in. These tables are named <check-out name>_OM and <check-out name>_RC. If tables with these names already exist, they are deleted and replaced with a new pair of tables for the check in. If the check in process fails, these tables are not recovered.

The <check-out name>_OM table records the pre- and post- check-in ObjectID values for new features/rows that have been added. The <check-out name>_RC table records all the changes made to the checked out data which include inserts (0), updates (1) and deletes (2).

Conflicts

If reconcileCheckout is TRUE, the changes are applied to the check-out version and this version is reconciled with its parent version. If reconcileCheckout is FALSE, the changes are applied to the check-out version, but no reconcile is performed.
If reconcileCheckout is TRUE and there are no conflicts during reconcile, a FALSE is returned, otherwise TRUE is returned. Conflicts can occur if a feature is edited in the check-out database and in the parent version of the parent database.

You should never edit the check-out version prior to check in. During check in, any coincidental changes are over-written with changes from the check-out database without notification of a conflict.

If you set reconcileCheckout to TRUE and there are conflicts or if reconcileCheckout is set to FALSE, the check-out version is updated and remains on the parent database. This allows you to manually reconcile at a later time. If you set reconcileCheckout to TRUE and there are no conflicts, the check-out version is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
parentDB - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
checkoutName - The checkoutName (in)
checkOutDB - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
reconcileCheckout - The reconcileCheckout (in)
createOIDMappingTable - The createOIDMappingTable (in)
Returns:
The conflicts_detected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ICheckIn.checkInFromGDB(com.esri.arcgis.geodatabase.IWorkspaceName, String, com.esri.arcgis.geodatabase.IWorkspaceName, boolean, boolean), ICheckIn, CheckIn

checkInFromDeltaFile

boolean checkInFromDeltaFile(IWorkspaceName parentDB,
                             String checkoutName,
                             String fileName,
                             int dcOption,
                             boolean reconcileCheckout,
                             boolean createOIDMappingTable)
                             throws IOException,
                                    AutomationException
Checks in changes from a delta database.

Remarks

The CheckinfromDeltaFile method applies the changes from a delta database (dcOption = esriExporttoAccess) or a delta XML file (dcOption = esriExporttoXML). See the DataChangesExporter for more information on delta files.

The checkoutName is needed to identify the check-out that is being checked in.

If createOIDMappingTable is True, tables are created in the parent replica geodatabase that describe the changes that are checked in. These tables are named <check-out name>_OM and <check-out name>_RC. If tables with these names already exist, they are over-written.

The <check-out name>_OM table records the pre- and post- check-in ObjectID values for new features/rows that have been added. The <check-out name>_RC table records all the changes made to the checked out data which include inserts (0), updates (1) and deletes (2).

Conflicts

If reconcileCheckout is TRUE, the changes are applied to the check-out version and this version is reconciled with its parent version. If reconcileCheckout is FALSE, the changes are applied to the check-out version, but no reconcile is performed.

If reconcileCheckout is TRUE and there are no conflicts during reconcile, a FALSE is returned, otherwise TRUE is returned. Conflicts can occur if a feature is edited in the check-out database and in the parent version of the parent database.

You should never edit the check-out version prior to check in. During check in, any coincidental changes are over-written with changes from the check-out database without notification of a conflict.

If you set reconcileCheckout to TRUE and there are conflicts or if reconcileCheckout is set to FALSE, the check-out version is updated and remains on the parent geodatabase. This allows you to manually reconcile at a later time. If you set reconcileCheckout to TRUE and there are no conflicts, the check-out version is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
parentDB - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
checkoutName - The checkoutName (in)
fileName - The fileName (in)
dcOption - A com.esri.arcgis.geodatabasedistributed.esriExportDataChangesOption constant (in)
reconcileCheckout - The reconcileCheckout (in)
createOIDMappingTable - The createOIDMappingTable (in)
Returns:
The conflicts_detected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.