com.esri.arcgis.geodatabase
Interface IGPReplicaOptions

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPReplicaOptions2

All Known Implementing Classes:

GPReplicaOptions

public interface IGPReplicaOptions
extends Serializable

Remarks

This interface contains properties that define the options to use when creating a replica.

Product Availability

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

Method Summary

int	getAccessType() The replica access type.
String	getChildConnectionString() The connection string for the child geodatabase.
int	getChildReconcilePolicy() The childs replica reconcile property.
String	getParentConnectionString() The connection string for the parent geodatabase.
int	getParentReconcilePolicy() The parents replica reconcile policy.
boolean	isChildFirstSender() Indicates if the child replica will be the first sender.
boolean	isRegisterReplicaOnly() Indicates if the replica will be created using the register existing data only option.
void	setAccessType(int accessType) The replica access type.
void	setChildConnectionString(String childConnectionString) The connection string for the child geodatabase.
void	setChildReconcilePolicy(int childPolicy) The childs replica reconcile property.
void	setIsChildFirstSender(boolean childIsFirstSender) Indicates if the child replica will be the first sender.
void	setParentConnectionString(String parentConnectionString) The connection string for the parent geodatabase.
void	setParentReconcilePolicy(int parentPolicy) The parents replica reconcile policy.
void	setRegisterReplicaOnly(boolean registerReplicaData) Indicates if the replica will be created using the register existing data only option.

Method Detail

setIsChildFirstSender

void setIsChildFirstSender(boolean childIsFirstSender)
                           throws IOException,
                                  AutomationException

Indicates if the child replica will be the first sender.

Product Availability

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

Parameters:

childIsFirstSender - The childIsFirstSender (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChildFirstSender

boolean isChildFirstSender()
                           throws IOException,
                                  AutomationException

Indicates if the child replica will be the first sender.

Product Availability

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

Returns:

The childIsFirstSender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessType

void setAccessType(int accessType)
                   throws IOException,
                          AutomationException

The replica access type.

Product Availability

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

Parameters:

accessType - A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccessType

int getAccessType()
                  throws IOException,
                         AutomationException

The replica access type.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaAccessType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildReconcilePolicy

void setChildReconcilePolicy(int childPolicy)
                             throws IOException,
                                    AutomationException

The childs replica reconcile property.

Product Availability

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

Parameters:

childPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildReconcilePolicy

int getChildReconcilePolicy()
                            throws IOException,
                                   AutomationException

The childs replica reconcile property.

Remarks

For the current release of ArcGIS, the only valid value for this property is esriReplicaResolveConflictsNone. When creating a replica, an error occurs if you try to use differnet enumeration value.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentReconcilePolicy

void setParentReconcilePolicy(int parentPolicy)
                              throws IOException,
                                     AutomationException

The parents replica reconcile policy.

Product Availability

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

Parameters:

parentPolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentReconcilePolicy

int getParentReconcilePolicy()
                             throws IOException,
                                    AutomationException

The parents replica reconcile policy.

Remarks

For the current release of ArcGIS, the only valid value for this property is esriReplicaResolveConflictsNone. When creating a replica, an error occurs if you try to use differnet enumeration value.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRegisterReplicaOnly

void setRegisterReplicaOnly(boolean registerReplicaData)
                            throws IOException,
                                   AutomationException

Indicates if the replica will be created using the register existing data only option.

Product Availability

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

Parameters:

registerReplicaData - The registerReplicaData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRegisterReplicaOnly

boolean isRegisterReplicaOnly()
                              throws IOException,
                                     AutomationException

Indicates if the replica will be created using the register existing data only option.

Product Availability

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

Returns:

The registerReplicaData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildConnectionString

void setChildConnectionString(String childConnectionString)
                              throws IOException,
                                     AutomationException

The connection string for the child geodatabase.

Product Availability

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

Parameters:

childConnectionString - The childConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildConnectionString

String getChildConnectionString()
                                throws IOException,
                                       AutomationException

The connection string for the child geodatabase.

Remarks

Set this property to the connection string for the ArcSDE geodatabase or the geodata service referencing the ArcSDE geodatabase that will host the child replica. Setting the property stores the connection string with the parent replica. This allows you to synchronzie without having to ask for the child replicas geodatabase when synchronizing from the parent.

Product Availability

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

Returns:

The childConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentConnectionString

void setParentConnectionString(String parentConnectionString)
                               throws IOException,
                                      AutomationException

The connection string for the parent geodatabase.

Product Availability

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

Parameters:

parentConnectionString - The parentConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParentConnectionString

String getParentConnectionString()
                                 throws IOException,
                                        AutomationException

The connection string for the parent geodatabase.

Remarks

Set this property to the connection string for the ArcSDE geodatabase or the geodata service referencing the ArcSDE geodatabase that will host the parent replica. Setting the property stores the connection string with the child replica. This allows you to synchronzie without having to ask for the parent replicas geodatabase when synchronizing from the child.

Product Availability

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

Returns:

The parentConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.