com.esri.arcgis.geodatabase
Interface IReplicaFilterDescription

All Superinterfaces:

Serializable

All Known Subinterfaces:

IReplicaFilterDescription2

All Known Implementing Classes:

ReplicaDescription

public interface IReplicaFilterDescription
extends Serializable

Provides access to members that return a replica's properties.

Superseded By

IReplicaFilterDescription2

Remarks

To perform a check out or a data extraction, the properties in the IReplicaFilterDescriptionEdit interface must be set to define the rows to check out. If none of these properties is set, all rows are checked out for all datasets in the check-out.

This interface provides read access to the properties set in IReplicaFilterDescriptionEdit.

Product Availability

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

Method Summary

IGeometry	getGeometry() The geometry used to determine which features to extract or check out.
int	getRowsType(int index) Replica row type options.
int	getSpatialRelation() The spatial operator used for a replica.
String	getTableDefQuery(int index) The definition query to use when checking out a dataset.
ISelectionSet	getTableSelection(int index) The selection set to use when checking out a dataset.
boolean	isTableUsesDefQuery(int index) Indicates if a definition query will be used when checking out a dataset.
boolean	isTableUsesQueryGeometry(int index) Indicates if a spatial extent will be used when checking out a dataset.
boolean	isTableUsesSelection(int index) Indicates if a selection will be used when checking out a dataset.

Method Detail

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException

The geometry used to determine which features to extract or check out.

Remarks

This property returns the shape that is used to determine which features are to be checked out. 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 checked out.

If a geometry is not used for the check-out, nothing is returned.

By default, the geometry is applied to all datasets in the replica description during a check out or extraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getSpatialRelation

int getSpatialRelation()
                       throws IOException,
                              AutomationException

The spatial operator used for a replica.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesQueryGeometry

boolean isTableUsesQueryGeometry(int index)
                                 throws IOException,
                                        AutomationException

Indicates if a spatial extent will be used when checking out a dataset.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The useGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesSelection

boolean isTableUsesSelection(int index)
                             throws IOException,
                                    AutomationException

Indicates if a selection will be used when checking out a dataset.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The useSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesDefQuery

boolean isTableUsesDefQuery(int index)
                            throws IOException,
                                   AutomationException

Indicates if a definition query will be used when checking out a dataset.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The useDefinition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableSelection

ISelectionSet getTableSelection(int index)
                                throws IOException,
                                       AutomationException

The selection set to use when checking out a dataset.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableDefQuery

String getTableDefQuery(int index)
                        throws IOException,
                               AutomationException

The definition query to use when checking out a dataset.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The defQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowsType

int getRowsType(int index)
                throws IOException,
                       AutomationException

Replica row type options.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geodatabase.esriRowsType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.