com.esri.arcgis.geodatabase
Interface IReplicaEdit

All Superinterfaces:

Serializable

All Known Subinterfaces:

IReplicaEdit2

All Known Implementing Classes:

Replica

public interface IReplicaEdit
extends Serializable

Provides access to members that modify information for a replica.

Superseded By

IReplicaEdit2

Remarks

This interface allows you to update the properties of check-out. The interface provides write only access to the properties of the IReplica interface. To apply the updates, you must use the IWorkspaceReplicasAdmin::AlterReplica method after setting these properties.

Product Availability

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

Method Summary

void	init(IReplica otherReplica) Init the replica from other replica.
void	setConnectionInfoByRef(IWorkspaceName rhs1) The connection string for the master geodatabase.
void	setDescriptionByRef(IReplicaDescription rhs1) The replica version description.
void	setName(String rhs1) The name of the replica.
void	setOwner(String rhs1) The master geodatabase login used to create the replica.
void	setParentID(int rhs1) The ID of the replica reference in the master geodatabase.
void	setReplicaDatasetsByRef(IEnumReplicaDataset rhs1) The replica datasets for this replica.
void	setReplicaDate(double rhs1) The date that the data was checked out.
void	setReplicaGuid(String rhs1) The guid of the replica.
void	setReplicaID(int rhs1) The ID of the replica.
void	setReplicaRole(int rhs1) Determines if the workspace is the replica geodatabase or the master geodatabase for the replica.
void	setVersion(String rhs1) The name of the replica version.

Method Detail

setReplicaID

void setReplicaID(int rhs1)
                  throws IOException,
                         AutomationException

The ID of the replica.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String rhs1)
             throws IOException,
                    AutomationException

The name of the replica.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

void setOwner(String rhs1)
              throws IOException,
                     AutomationException

The master geodatabase login used to create the replica.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersion

void setVersion(String rhs1)
                throws IOException,
                       AutomationException

The name of the replica version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentID

void setParentID(int rhs1)
                 throws IOException,
                        AutomationException

The ID of the replica reference in the master geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaDate

void setReplicaDate(double rhs1)
                    throws IOException,
                           AutomationException

The date that the data was checked out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaGuid

void setReplicaGuid(String rhs1)
                    throws IOException,
                           AutomationException

The guid of the replica.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescriptionByRef

void setDescriptionByRef(IReplicaDescription rhs1)
                         throws IOException,
                                AutomationException

The replica version description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionInfoByRef

void setConnectionInfoByRef(IWorkspaceName rhs1)
                            throws IOException,
                                   AutomationException

The connection string for the master geodatabase.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaRole

void setReplicaRole(int rhs1)
                    throws IOException,
                           AutomationException

Determines if the workspace is the replica geodatabase or the master geodatabase for the replica.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A com.esri.arcgis.geodatabase.esriReplicaType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaDatasetsByRef

void setReplicaDatasetsByRef(IEnumReplicaDataset rhs1)
                             throws IOException,
                                    AutomationException

The replica datasets for this replica.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IEnumReplicaDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

void init(IReplica otherReplica)
          throws IOException,
                 AutomationException

Init the replica from other replica.

Remarks

The Init method allows you to initialize a new check-out based on another check-out. This method along with the IWorkspaceReplicasAdmin::RegisterReplica method can be used to create the meta-data for a new check-out. See the Duplicating Check-outs sample in the ArcObjects help for an example of where this can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

otherReplica - 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.