com.esri.arcgis.geodatabase
Class IWorkspaceReplicasAdminProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IWorkspaceReplicasAdminProxy

All Implemented Interfaces:

IWorkspaceReplicasAdmin, Externalizable, Serializable

Direct Known Subclasses:

IWorkspaceReplicasAdmin2Proxy

public class IWorkspaceReplicasAdminProxy
extends com.esri.arcgis.interop.Dispatch
implements IWorkspaceReplicasAdmin, 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.

See Also:

IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicaDatasets, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IWorkspaceReplicasAdminProxy()
	IWorkspaceReplicasAdminProxy(Object obj)
protected	IWorkspaceReplicasAdminProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterReplica(IReplica replica) Updates replica information.
int	registerReplica(IReplica replica) Creates new replica information.
void	removeListener(String iidStr, Object theListener)
void	unregisterReplica(IReplica replica, boolean removeCOVersion) Removes replica information.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IWorkspaceReplicasAdminProxy

public IWorkspaceReplicasAdminProxy()

IWorkspaceReplicasAdminProxy

public IWorkspaceReplicasAdminProxy(Object obj)
                             throws IOException

Throws:

IOException

IWorkspaceReplicasAdminProxy

protected IWorkspaceReplicasAdminProxy(Object obj,
                                       String iid)
                                throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

alterReplica

public 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

Specified by:

alterReplica in interface IWorkspaceReplicasAdmin

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

public 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

Specified by:

registerReplica in interface IWorkspaceReplicasAdmin

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

public 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

Specified by:

unregisterReplica in interface IWorkspaceReplicasAdmin

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.