com.esri.arcgis.geodatabase
Interface IWorkspaceReplicasAdmin

All Superinterfaces:
Serializable
All Known Subinterfaces:
IWorkspaceReplicasAdmin2
All Known Implementing Classes:
IWorkspaceReplicasAdmin2Proxy, IWorkspaceReplicasAdminProxy, Workspace

public interface IWorkspaceReplicasAdmin
extends Serializable

Provides access to members that modify information about a replica.

Superseded By

IWorkspaceReplicasAdmin2

Remarks

When a check-out is performed, one of the final steps is to add metadata to the master and check-out geodatabases for the check-out. This metadata is used as a record of the check-out while it is active and also during check-in to get to needed information. The infomation stored in the metadata can be accessed using the Replica and ReplicaDataset classes. Once the check-out is checked in, the metadata is removed.

This interface provides methods to create, delete and update existing check-out metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicaDatasets

Method Summary
 void alterReplica(IReplica replica)
          Updates replica information.
 int registerReplica(IReplica replica)
          Creates new replica information.
 void unregisterReplica(IReplica replica, boolean removeCOVersion)
          Removes replica information.
 

Method Detail

alterReplica

void alterReplica(IReplica replica)
                  throws IOException,
                         AutomationException
Updates replica information.

Remarks

Care should be taken when altering the replica metadata. It is possible to modify the metadata with this method in a way that will cause the synchronization to fail.

In order to alter a property of a replica, you must use the Replica::IReplicaEdit interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerReplica

int registerReplica(IReplica replica)
                    throws IOException,
                           AutomationException
Creates new replica information.

Remarks

The RegisterReplica method creates new metadata for a replica. This method does not create the check-out version or the SYNC version in ArcSDE geodatabases.

To register a new replica, you must first call the IReplicaEdit::Init to initialize a new replica from an existing one. This ensures that the new replica will have an appropriate ReplicaID and ReplicaGUID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Returns:
The replicaID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unregisterReplica

void unregisterReplica(IReplica replica,
                       boolean removeCOVersion)
                       throws IOException,
                              AutomationException
Removes replica information.

Remarks

This method removes the replicas metadata from the geodatabase. If removeCOVersion is true, the checkout version and the SYNC version are also removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
removeCOVersion - The removeCOVersion (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.