com.esri.arcgis.geodatabase
Interface IGPReplicaDatasets

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPReplicaDatasets

public interface IGPReplicaDatasets
extends Serializable

Provides access to members that define replica datasets

Product Availability

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

Method Summary

void	add(IGPReplicaDataset gPReplicaDataset) Adds replica dataset object.
int	getCount() The dataset count.
IGPReplicaDataset	getElement(int index) Returns the replica dataset at the specified position.
void	insert(int index, IGPReplicaDataset gPReplicaDataset) Adds dataset filtered property at the specified position.
void	remove(int index) Removes the replica dataset at the specified position.
void	removeAll() Removes all replica dataset objects.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The dataset count.

Remarks

The number of replica datasets in the enumeration.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IGPReplicaDataset getElement(int index)
                             throws IOException,
                                    AutomationException

Returns the replica dataset at the specified position.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the replica dataset at the specified position.

Remarks

This method removes the replica dataset at the specified location from the GPReplicaDatasets object. The only parameter is the index of the replica dataset to remove.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all replica dataset objects.

Remarks

The method removes all replica datasets from the GPReplicaDatasets object.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IGPReplicaDataset gPReplicaDataset)
         throws IOException,
                AutomationException

Adds replica dataset object.

Remarks

This method adds a replica dataset to the GPReplicaDatasets object.

The only parameter for this method is the GPReplicaDataset. See the GPReplicaDataset object for more information.

Product Availability

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

Parameters:

gPReplicaDataset - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGPReplicaDataset gPReplicaDataset)
            throws IOException,
                   AutomationException

Adds dataset filtered property at the specified position.

Remarks

This method adds a replica dataset to the GPReplicaDatasets at a specified location.

This method takes an index and a reference to a GPReplicaDataset object. See the GPReplicaDataset coclass.

Product Availability

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

Parameters:

index - The index (in)

gPReplicaDataset - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.