com.esri.arcgis.geodatabase
Interface IWorkspaceReplicas

All Superinterfaces:

Serializable

All Known Subinterfaces:

IWorkspaceReplicas2

All Known Implementing Classes:

IWorkspaceReplicas2Proxy, IWorkspaceReplicasProxy, Workspace

public interface IWorkspaceReplicas
extends 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.

See Also:

IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicaDatasets

Method Summary

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	refreshReplicas() Re-reads the list of replicas from the database.

Method Detail

getReplicas

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

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

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.

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

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.

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

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.

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.