com.esri.arcgis.geodatabase
Interface IWorkspaceReplicasAdmin2

All Superinterfaces:

IWorkspaceReplicasAdmin, Serializable

All Known Subinterfaces:

IWorkspaceReplicasAdmin3

All Known Implementing Classes:

IWorkspaceReplicasAdmin2Proxy, IWorkspaceReplicasAdmin3Proxy, Workspace

public interface IWorkspaceReplicasAdmin2
extends IWorkspaceReplicasAdmin, Serializable

Provides access to members that modify information about a replica.

Product Availability

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

Method Summary

void	alterReplica2(IReplica replica, boolean persistParentUserInfo) Alter replica properties with the ability to persist userID and Password.
boolean	canRegisterReplicaDataset(IReplicaDataset replicaDataset, IReplica replica) Indicates if a replica dataset can be registed with the replica.
boolean	canUnregisterReplicaDataset(IReplicaDataset replicaDataset) Indicates if a replica dataset can be unregisted from the replica.
boolean	isReferencedByReplica(int datasetType, int datasetID) Indicates if dataset is part of a replica.
void	registerReplicaDataset(IReplicaDataset rDataset, int filter, boolean useGeometry, String queryDef, IFIDSet pSelID, IReplica pToReplica) Register replica dataset info with the replica.
void	unregisterReplicaDataset(IReplicaDataset replicaDataset, IReplica replica) Removes replica dataset info from the replica.

Methods inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicasAdmin

alterReplica, registerReplica, unregisterReplica

Method Detail

canRegisterReplicaDataset

boolean canRegisterReplicaDataset(IReplicaDataset replicaDataset,
                                  IReplica replica)
                                  throws IOException,
                                         AutomationException

Indicates if a replica dataset can be registed with the replica.

Product Availability

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

Parameters:

replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)

replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)

Returns:

The canRegister

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerReplicaDataset

void registerReplicaDataset(IReplicaDataset rDataset,
                            int filter,
                            boolean useGeometry,
                            String queryDef,
                            IFIDSet pSelID,
                            IReplica pToReplica)
                            throws IOException,
                                   AutomationException

Register replica dataset info with the replica.

Remarks

Feature classes and tables can be registered using this method. Other datasets may or may not be supported - use the CanRegisterReplicaDataset method to determine whether they can be registered.

Product Availability

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

Parameters:

rDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)

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

useGeometry - The useGeometry (in)

queryDef - The queryDef (in)

pSelID - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

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

canUnregisterReplicaDataset

boolean canUnregisterReplicaDataset(IReplicaDataset replicaDataset)
                                    throws IOException,
                                           AutomationException

Indicates if a replica dataset can be unregisted from the replica.

Product Availability

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

Parameters:

replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)

Returns:

The canUnregister

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unregisterReplicaDataset

void unregisterReplicaDataset(IReplicaDataset replicaDataset,
                              IReplica replica)
                              throws IOException,
                                     AutomationException

Removes replica dataset info from the replica.

Product Availability

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

Parameters:

replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)

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.

alterReplica2

void alterReplica2(IReplica replica,
                   boolean persistParentUserInfo)
                   throws IOException,
                          AutomationException

Alter replica properties with the ability to persist userID and Password.

Product Availability

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

Parameters:

replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)

persistParentUserInfo - The persistParentUserInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReferencedByReplica

boolean isReferencedByReplica(int datasetType,
                              int datasetID)
                              throws IOException,
                                     AutomationException

Indicates if dataset is part of a replica.

Product Availability

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

Parameters:

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

datasetID - The datasetID (in)

Returns:

The isReferenced

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.