com.esri.arcgis.geodatabasedistributed
Interface IReplicaProgress

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
IReplicaProgressAdapter, IReplicaProgressProxy

public interface IReplicaProgress
extends EventListener, Serializable

Provides access to members that monitor the progress of a check-out.

Remarks

The IReplicaProgress interface is an outbound interface that can be used by a client to monitor a check out, data extraction or check in process. This in conjunction with the IFeatureProgress interface below provide all of the information used by the check out, check in and data extraction progress dialogs in the user interface.

The following describes the information provided when these properties and methods are fired:

Property / Method Description
CurrentReplicaOperation Returns the current step (i.e. extracting schema).
ReplicaObjectCount Returns the number of operations to be performed.
ReplicaOperations Returns the list of operations to be performed.
Startup Returns the first operation to be performed.

This interface uses the esriReplicaProgress enumeration to keep track of the status of the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void setCurrentReplicaOperation(IReplicaProgressSetCurrentReplicaOperationEvent theEvent)
          The current operation in a check-out process.
 void setReplicaObjectCount(IReplicaProgressSetReplicaObjectCountEvent theEvent)
          The number of objects to check-out.
 void setReplicaOperations(IReplicaProgressSetReplicaOperationsEvent theEvent)
          The number of operations to perform in a check-out.
 void startup(IReplicaProgressStartupEvent theEvent)
          Initiate the check-out progress utility.
 

Method Detail

startup

void startup(IReplicaProgressStartupEvent theEvent)
             throws IOException,
                    AutomationException
Initiate the check-out progress utility.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentReplicaOperation

void setCurrentReplicaOperation(IReplicaProgressSetCurrentReplicaOperationEvent theEvent)
                                throws IOException,
                                       AutomationException
The current operation in a check-out process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplicaOperations

void setReplicaOperations(IReplicaProgressSetReplicaOperationsEvent theEvent)
                          throws IOException,
                                 AutomationException
The number of operations to perform in a check-out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReplicaObjectCount

void setReplicaObjectCount(IReplicaProgressSetReplicaObjectCountEvent theEvent)
                           throws IOException,
                                  AutomationException
The number of objects to check-out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.