com.esri.arcgis.geodatabase
Interface IGPReplicaDataset

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPReplicaDataset2

All Known Implementing Classes:

GPReplicaDataset

public interface IGPReplicaDataset
extends Serializable

Provides access to members that return the properties of a replica dataset.

Remarks

This interface has properties that describe the datasets in a replica.

Product Availability

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

Method Summary

int	getDatasetType() The dataset type.
String	getDefQuery() Definition query for the replica dataset.
String	getName() The name of the dataset.
String	getRelDestinationClass() The destination class for the relationship class.
int	getRelExtractDirection() Defines the direction of the replicated relationship class.
String	getRelOriginClass() The origin class for the relationship class.
int	getRowsType() Defines the replicated rows.
ILongArray	getSelectionIDs() Array of selected IDs.
boolean	isPrivate() Indicates if the replica dataset is private.
boolean	isUseGeometry() Indicates if the geometry defined in the replica description is applied to the replica dataset.
void	setDatasetType(int datasetType) The dataset type.
void	setDefQuery(String defQuery) Definition query for the replica dataset.
void	setIsPrivate(boolean isPrivate) Indicates if the replica dataset is private.
void	setName(String name) The name of the dataset.
void	setRelDestinationClass(String destClass) The destination class for the relationship class.
void	setRelExtractDirection(int relExtractDir) Defines the direction of the replicated relationship class.
void	setRelOriginClass(String originClass) The origin class for the relationship class.
void	setRowsType(int rowsType) Defines the replicated rows.
void	setSelectionIDsByRef(ILongArray longArray) Array of selected IDs.
void	setUseGeometry(boolean useGeometry) Indicates if the geometry defined in the replica description is applied to the replica dataset.

Method Detail

setName

void setName(String name)
             throws IOException,
                    AutomationException

The name of the dataset.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the dataset.

Remarks

Returns the name of the dataset.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetType

void setDatasetType(int datasetType)
                    throws IOException,
                           AutomationException

The dataset type.

Product Availability

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

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetType

int getDatasetType()
                   throws IOException,
                          AutomationException

The dataset type.

Remarks

The DatasetType property will return one of the following:

esriDTFeatureClass
esriDTTable
esriDTRelationshipClass

From these values, you can determine the associated feature datasets, geometric networks or topologies.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRowsType

void setRowsType(int rowsType)
                 throws IOException,
                        AutomationException

Defines the replicated rows.

Remarks

This property allows you to control, on an individual dataset level whether all data, only the schema or only data satisfying the other IGPReplicaDataset properties will be replicated.

By default, FeatureClasses are set to esriRowsTypeFilter while tables return esriRowsTypeNone. See the esriRowsType enumeration for more information.

Product Availability

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

Parameters:

rowsType - A com.esri.arcgis.geodatabase.esriRowsType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowsType

int getRowsType()
                throws IOException,
                       AutomationException

Defines the replicated rows.

Remarks

Returns the rows type of the replica dataset as a value of the esriRowsType enumeration. Only datasets that return esriRowsTypeFilter apply the filters imposed by the other returned properties in IGPReplicaDataset.

See the esriRowsType enumeration for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriRowsType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivate

void setIsPrivate(boolean isPrivate)
                  throws IOException,
                         AutomationException

Indicates if the replica dataset is private.

Product Availability

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

Parameters:

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivate

boolean isPrivate()
                  throws IOException,
                         AutomationException

Indicates if the replica dataset is private.

Remarks

Returns TRUE if the dataset is private. Returns FALSE if it is not private

Product Availability

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

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGeometry

void setUseGeometry(boolean useGeometry)
                    throws IOException,
                           AutomationException

Indicates if the geometry defined in the replica description is applied to the replica dataset.

Product Availability

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

Parameters:

useGeometry - The useGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGeometry

boolean isUseGeometry()
                      throws IOException,
                             AutomationException

Indicates if the geometry defined in the replica description is applied to the replica dataset.

Description

The property is TRUE by default.

Product Availability

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

Returns:

The useGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefQuery

void setDefQuery(String defQuery)
                 throws IOException,
                        AutomationException

Definition query for the replica dataset.

Product Availability

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

Parameters:

defQuery - The defQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefQuery

String getDefQuery()
                   throws IOException,
                          AutomationException

Definition query for the replica dataset.

Remarks

The definition query for the replica dataset.

Product Availability

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

Returns:

The defQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionIDsByRef

void setSelectionIDsByRef(ILongArray longArray)
                          throws IOException,
                                 AutomationException

Array of selected IDs.

Product Availability

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

Parameters:

longArray - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionIDs

ILongArray getSelectionIDs()
                           throws IOException,
                                  AutomationException

Array of selected IDs.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelExtractDirection

void setRelExtractDirection(int relExtractDir)
                            throws IOException,
                                   AutomationException

Defines the direction of the replicated relationship class.

Product Availability

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

Parameters:

relExtractDir - A com.esri.arcgis.geodatabase.esriRelExtractDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelExtractDirection

int getRelExtractDirection()
                           throws IOException,
                                  AutomationException

Defines the direction of the replicated relationship class.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriRelExtractDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelOriginClass

void setRelOriginClass(String originClass)
                       throws IOException,
                              AutomationException

The origin class for the relationship class.

Product Availability

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

Parameters:

originClass - The originClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelOriginClass

String getRelOriginClass()
                         throws IOException,
                                AutomationException

The origin class for the relationship class.

Product Availability

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

Returns:

The originClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelDestinationClass

void setRelDestinationClass(String destClass)
                            throws IOException,
                                   AutomationException

The destination class for the relationship class.

Product Availability

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

Parameters:

destClass - The destClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelDestinationClass

String getRelDestinationClass()
                              throws IOException,
                                     AutomationException

The destination class for the relationship class.

Product Availability

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

Returns:

The destClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.