com.esri.arcgis.geodatabase
Interface IGPReplicaDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPReplicaDescription

public interface IGPReplicaDescription
extends Serializable

Provides access to members which set and return the properties of a GPReplicaDescription object.

Remarks

Contains properties that can be set to define the the data to replicate or extract or are returned from existing replicas

Product Availability

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

Method Summary

int	getModelType() The replica model type.
IGeometry	getQueryGeometry() The shape that determines which features are replicated.
IGPReplicaDatasets	getReplicaDatasets() The datasets in the replica.
int	getSpatialRelation() Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.
void	init(IReplica replica) Initializes the object from an existing replica.
boolean	isSingleGeneration() Indicates if the replica is a check-out.
boolean	isTransferRelatedObjects() Indicates if related objects are replicated.
void	setModelType(int modelType) The replica model type.
void	setQueryGeometryByRef(IGeometry queryGeometry) The shape that determines which features are replicated.
void	setReplicaDatasetsByRef(IGPReplicaDatasets replicaDatasets) The datasets in the replica.
void	setSingleGeneration(boolean singleGeneration) Indicates if the replica is a check-out.
void	setSpatialRelation(int spatialRelation) Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.
void	setTransferRelatedObjects(boolean transferRelObjects) Indicates if related objects are replicated.

Method Detail

init

void init(IReplica replica)
          throws IOException,
                 AutomationException

Initializes the object from an existing replica.

Remarks

Initialzes a GPReplicaDescription object from an existing Replica in the geodatabase. The object describes the data that has been replicated.

Product Availability

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

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.

setModelType

void setModelType(int modelType)
                  throws IOException,
                         AutomationException

The replica model type.

Remarks

The ModelType defines whether to output the data as simple datasets (esriModelTypeSimple) or as they are defined in the parent replica geodatabase (esriModelTypeFullGeodatabase).

By default this property is set to esriModelTypeFullGeodatabase.

See the esriReplicaModelType enumeration for more information.

Product Availability

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

Parameters:

modelType - A com.esri.arcgis.geodatabase.esriReplicaModelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModelType

int getModelType()
                 throws IOException,
                        AutomationException

The replica model type.

Remarks

This property returns the ModelType for existng replicas and allows you to set the type when creating a replica. Only one way replicas can have a type of either esriModelTypeSimple or esriModelTypeFullGeodatabase. Two way and check-out replicas always have a esriModelTypeFullGeodatabase model type.

The ModelType defines whether to output the data as simple datasets (esriModelTypeSimple) or as they are defined in the parent replica geodatabase (esriModelTypeFullGeodatabase). For example, when creating a replica from data with complex types such as a topologies or a geometric networks, a full model type includes the topolgies and geometric networks while the simple model does not.

By default this property is set to esriModelTypeFullGeodatabase.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaModelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSingleGeneration

void setSingleGeneration(boolean singleGeneration)
                         throws IOException,
                                AutomationException

Indicates if the replica is a check-out.

Remarks

Determines whether replica created will be a check-out replica (single generation) or a multi-generation replica (includes two way and one way replicas).

To create a check-out replica set this property to TRUE. By default this is set to TRUE.

When creating a two way or one way replica set this to FALSE. Use the IGPReplicaOptions::AccessType property to specify to create either a two way or one way replica. See the GPReplicaOptions coclass for more information.

Product Availability

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

Parameters:

singleGeneration - The singleGeneration (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSingleGeneration

boolean isSingleGeneration()
                           throws IOException,
                                  AutomationException

Indicates if the replica is a check-out.

Remarks

Returns TRUE if the replica is a check-out replica (single generation replica). Returns FALSE if replica is either a two way or one way replica.

Product Availability

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

Returns:

The singleGeneration

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelation

void setSpatialRelation(int spatialRelation)
                        throws IOException,
                               AutomationException

Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.

Remarks

This property defines how the shape returned by the Geometry property is applied during replication. For example, if the geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are replicated.

By default this property is set to esriSpatialRelIntersects. See the esriSpatialRelEnum enumeration for more information.

Product Availability

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

Parameters:

spatialRelation - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelation

int getSpatialRelation()
                       throws IOException,
                              AutomationException

Defines how the shape returned by the QueryGeometry property is applied during replication and synchronization.

Remarks

This property defines how the shape returned by the Geometry property is applied during replication. For example, if the geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are replicated.

By default this property is set to esriSpatialRelIntersects. See the esriSpatialRelEnum enumeration for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryGeometryByRef

void setQueryGeometryByRef(IGeometry queryGeometry)
                           throws IOException,
                                  AutomationException

The shape that determines which features are replicated.

Remarks

Set this property if you want to add an association with the specified shape to determine the features to replicate. The association is defined by the SpatialRelation property. For example, if the Geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are replicated.

The SpatialReference of the geometry is significant. Data from the replica feature classes gets projected into this spatial reference when the geometry association is applied. If the spatial reference of the geometry is not set, the features you expect to get replicated may not be included.

By default, the geometry is applied to all datasets in the replica description during replication.

Product Availability

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

Parameters:

queryGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryGeometry

IGeometry getQueryGeometry()
                           throws IOException,
                                  AutomationException

The shape that determines which features are replicated.

Remarks

This property returns the shape that is used to determine which features are to be replicated. The SpatialRelation property returns how this shape is applied as a filter. For example, if the Geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are replicated.

If a geometry is not used for the replica, nothing is returned.

By default, the geometry is applied to all datasets in the replica description during replication.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaDatasetsByRef

void setReplicaDatasetsByRef(IGPReplicaDatasets replicaDatasets)
                             throws IOException,
                                    AutomationException

The datasets in the replica.

Product Availability

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

Parameters:

replicaDatasets - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaDatasets

IGPReplicaDatasets getReplicaDatasets()
                                      throws IOException,
                                             AutomationException

The datasets in the replica.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransferRelatedObjects

void setTransferRelatedObjects(boolean transferRelObjects)
                               throws IOException,
                                      AutomationException

Indicates if related objects are replicated.

Remarks

TransferRelatedObjects determines whether related objects will be replicated.

If this is set to TRUE related objects will be replicated. TransferRelatedObjects is set to TRUE by default. If you don't want to replicate related objects set this property to FALSE.

Product Availability

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

Parameters:

transferRelObjects - The transferRelObjects (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTransferRelatedObjects

boolean isTransferRelatedObjects()
                                 throws IOException,
                                        AutomationException

Indicates if related objects are replicated.

Remarks

TransferRelatedObjects determines whether related objects will be replicated.

If this is set to TRUE related objects will be replicated. TransferRelatedObjects is set to TRUE by default.

Product Availability

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

Returns:

The transferRelObjects

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.