com.esri.arcgis.geodatabasedistributed
Interface ICheckOut

All Superinterfaces:
Serializable
All Known Implementing Classes:
CheckOut

public interface ICheckOut
extends Serializable

Provides access to members that perform a check out.

Remarks

This interface provides two methods for checking out data. The CheckoutData method checks out schema and data while CheckOutSchema method checks out only the schema.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void checkOutData(IReplicaDescription rDDescriptions, boolean transferRelObjects, String checkoutName)
          Checks out schema and data from a master geodatabase.
 void checkOutSchema(IReplicaDescription rDDescription, String checkoutName)
          Checks out only the schema of the selected datasets from a master geodatabase.
 

Method Detail

checkOutData

void checkOutData(IReplicaDescription rDDescriptions,
                  boolean transferRelObjects,
                  String checkoutName)
                  throws IOException,
                         AutomationException
Checks out schema and data from a master geodatabase.

Remarks

The CheckoutData method checks out schema and Data.

In order to perform a check-out, you need to set the rDDescriptions parameter to define the data to check out. See the ReplicaDescription coclass for more information. The CheckoutName is a string that uniquely identifies the checkout on the parent replica geodatabase (master geodatabase) and the check-out databases.

If you set transferRelatedObjects to TRUE, related features/rows from other feature classes/tables will also be checked out. Otherwise, they are not checked out. Note that the schema of the related objects is always included regardless of whether transferRelatedObjects is TRUE or FALSE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rDDescriptions - A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)
transferRelObjects - The transferRelObjects (in)
checkoutName - The checkoutName (in)
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

checkOutSchema

void checkOutSchema(IReplicaDescription rDDescription,
                    String checkoutName)
                    throws IOException,
                           AutomationException
Checks out only the schema of the selected datasets from a master geodatabase.

Remarks

The CheckOutSchema method checks out only the schema.

In order to perform a check-out, you need to set the rDDescriptions parameter to define the data to check out. See the ReplicaDescription coclass for more information. The CheckoutName is a string that uniquely identifies the checkout on the parent replica (master geodatabase) and the check-out databases.

The CheckoutSchema method checks out the schema of each dataset without any features or rows. This type of check-out is useful for cases where data is being collected for new projects and needs to be added to the existing database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rDDescription - A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)
checkoutName - The checkoutName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ICheckOut, IReplicaValidation, ICheckOut.checkOutData(com.esri.arcgis.geodatabase.IReplicaDescription, boolean, String), CheckOut