com.esri.arcgis.geodatabasedistributed
Class CheckOut

java.lang.Object
  com.esri.arcgis.geodatabasedistributed.CheckOut

All Implemented Interfaces:

ICheckOut, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CheckOut
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICheckOut

Checks out data from a master geodatabase to a check-out geodatabase.

Remarks

Use the CheckOut coclass when you wish to check out data or schema from an ArcSDE master geodatabase to a check-out geodatabase. The check-out geodatabase can be either a personal geodatabase or an ArcSDE geodatabase. It uses the same mechanism to transfer data as the DataExtraction coclass.

Once a check-out is created, information about the check-out is stored in both the master and check-out geodatabases. See the IWorkspaceReplicas interface for more on getting information about existing check-outs.

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, Serialized Form

Constructor Summary

CheckOut()
Constructs a CheckOut using ArcGIS Engine.

CheckOut(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CheckOut theCheckOut = (CheckOut) obj;

Method Summary

void	addIFeatureProgressListener(IFeatureProgress theListener) addIFeatureProgressListener.
void	addIReplicaProgressListener(IReplicaProgress theListener) addIReplicaProgressListener.
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.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	removeIFeatureProgressListener(IFeatureProgress theListener) removeIFeatureProgressListener.
void	removeIReplicaProgressListener(IReplicaProgress theListener) removeIReplicaProgressListener.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

CheckOut

public CheckOut()
         throws IOException,
                UnknownHostException

Constructs a CheckOut using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CheckOut

public CheckOut(Object obj)
         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CheckOut theCheckOut = (CheckOut) obj;

Construct a CheckOut using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CheckOut.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIFeatureProgressListener

public void addIFeatureProgressListener(IFeatureProgress theListener)
                                 throws IOException

addIFeatureProgressListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.

Throws:

IOException - If there are communications problems.

removeIFeatureProgressListener

public void removeIFeatureProgressListener(IFeatureProgress theListener)
                                    throws IOException

removeIFeatureProgressListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.

Throws:

IOException - If there are communications problems.

addIReplicaProgressListener

public void addIReplicaProgressListener(IReplicaProgress theListener)
                                 throws IOException

addIReplicaProgressListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IReplicaProgress interface.

Throws:

IOException - If there are communications problems.

removeIReplicaProgressListener

public void removeIReplicaProgressListener(IReplicaProgress theListener)
                                    throws IOException

removeIReplicaProgressListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IReplicaProgress interface.

Throws:

IOException - If there are communications problems.

checkOutData

public 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

Specified by:

checkOutData in interface ICheckOut

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

public 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

Specified by:

checkOutSchema in interface ICheckOut

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