com.esri.arcgis.geodatabase
Class IWorkspaceReplicasProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IWorkspaceReplicasProxy
All Implemented Interfaces:
IWorkspaceReplicas, Externalizable, Serializable
Direct Known Subclasses:
IWorkspaceReplicas2Proxy

public class IWorkspaceReplicasProxy
extends com.esri.arcgis.interop.Dispatch
implements IWorkspaceReplicas, Serializable

Provides access to members that return objects containing information about replicas.

Superseded By

IWorkspaceReplicas2

Remarks

Use this interface with geodatabases that are involved in check-outs. Methods and properties are included to return Replica objects which provide more information about specific checkouts. The interface can be used with either master or check-out geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicaDatasets, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IWorkspaceReplicasProxy()
           
  IWorkspaceReplicasProxy(Object obj)
           
protected IWorkspaceReplicasProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 IReplica getReplicaByGuid(String replicaGuid)
          The replica or reference to a replica with the specified ID.
 IReplica getReplicaByID(int replicaID)
          The replica or reference to a replica with the specified ID.
 IReplica getReplicaByName(String replicaName)
          The replica or reference to a replica with the specified name.
 IEnumReplica getReplicas()
          Replicas contained by or refernced by this workspace.
 void readExternal(ObjectInput in)
           
 void refreshReplicas()
          Re-reads the list of replicas from the database.
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IWorkspaceReplicasProxy

public IWorkspaceReplicasProxy()

IWorkspaceReplicasProxy

public IWorkspaceReplicasProxy(Object obj)
                        throws IOException
Throws:
IOException

IWorkspaceReplicasProxy

protected IWorkspaceReplicasProxy(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

getReplicas

public IEnumReplica getReplicas()
                         throws IOException,
                                AutomationException
Replicas contained by or refernced by this workspace.

Remarks

When using this method to get check-out information from a personal or File geodatabase, the enumeration will return no more than one Replica object. This is because personal and File geodatabases can only host one check-out. Many replicas may be returned with ArcSDE geodatabases since ArcSDE can host a check-out plus have references to many other check-outs.

If no replicas are returned, the geodatabase is not involved in an active check-out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getReplicas in interface IWorkspaceReplicas
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumReplica
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaByName

public IReplica getReplicaByName(String replicaName)
                          throws IOException,
                                 AutomationException
The replica or reference to a replica with the specified name.

Product Availability

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

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

getReplicaByID

public IReplica getReplicaByID(int replicaID)
                        throws IOException,
                               AutomationException
The replica or reference to a replica with the specified ID.

Product Availability

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

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

getReplicaByGuid

public IReplica getReplicaByGuid(String replicaGuid)
                          throws IOException,
                                 AutomationException
The replica or reference to a replica with the specified ID.

Product Availability

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

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

refreshReplicas

public void refreshReplicas()
                     throws IOException,
                            AutomationException
Re-reads the list of replicas from the database.

Remarks

Use this method to make your connection aware of check-outs being performed concurrently by other connections to the same database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
refreshReplicas in interface IWorkspaceReplicas
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException