com.esri.arcgis.geodatabase
Interface IGPReplica

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPReplica2

All Known Implementing Classes:

GPReplica

public interface IGPReplica
extends Serializable

Provides access to members that get information about a replica.

Remarks

This interface has properties that describe a replica.

Product Availability

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

Method Summary

int	getAccessType() Replica access type.
Object	getCreationDate() The date the replica was created.
String	getGUID() The guid of the replica.
int	getID() The ID of the replica.
int	getMyGenerationNumber() The generation number for the replica.
String	getName() Name of the replica.
int	getReconcilePolicy() The replica reconcile policy.
IGPReplicaDescription	getReplicaDescription() The replica description for the replica.
int	getReplicaState() The replica state.
String	getReplicaVersion() The name of the replica version.
int	getRole() The replica role.
String	getSibConnectionString() The connection string of the relative replica.
int	getSibGenerationNumber() The generation number of the relative replica.
int	getSibMyGenerationNumber() The last generation number that has been acknowledged by the relative replica.
void	init(IReplica replica) Initializes the class using an IReplica object.
boolean	isHasConflicts() Indicates if the replica is in conflict.
void	setAccessType(int accessType) Replica access type.
void	setCreationDate(Object replicaRole) The date the replica was created.
void	setGUID(String gUID) The guid of the replica.
void	setHasConflicts(boolean hasConflicts) Indicates if the replica is in conflict.
void	setID(int replicaID) The ID of the replica.
void	setMyGenerationNumber(int pMyGenerationNumber) The generation number for the replica.
void	setName(String replicaName) Name of the replica.
void	setReconcilePolicy(int policy) The replica reconcile policy.
void	setReplicaDescriptionByRef(IGPReplicaDescription replicaDescription) The replica description for the replica.
void	setReplicaState(int replicaState) The replica state.
void	setReplicaVersion(String replicaVersion) The name of the replica version.
void	setRole(int replicaRole) The replica role.
void	setSibConnectionString(String sibConnectionString) The connection string of the relative replica.
void	setSibGenerationNumber(int pSibGenerationNumber) The generation number of the relative replica.
void	setSibMyGenerationNumber(int pSibMyGenerationNumber) The last generation number that has been acknowledged by the relative replica.

Method Detail

init

void init(IReplica replica)
          throws IOException,
                 AutomationException

Initializes the class using an IReplica object.

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.

setName

void setName(String replicaName)
             throws IOException,
                    AutomationException

Name of the replica.

Description

The replica access type. Returns a value of the esriReplicaAccessType enumeration. See the esriReplicaAccessType enumeration for more information.

Product Availability

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

Parameters:

replicaName - The replicaName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the replica.

Product Availability

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

Returns:

The replicaName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

void setID(int replicaID)
           throws IOException,
                  AutomationException

The ID of the replica.

Product Availability

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

Parameters:

replicaID - The replicaID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

int getID()
          throws IOException,
                 AutomationException

The ID of the replica.

Product Availability

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

Returns:

The replicaID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGUID

void setGUID(String gUID)
             throws IOException,
                    AutomationException

The guid of the replica.

Product Availability

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

Parameters:

gUID - The gUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGUID

String getGUID()
               throws IOException,
                      AutomationException

The guid of the replica.

Product Availability

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

Returns:

The gUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRole

void setRole(int replicaRole)
             throws IOException,
                    AutomationException

The replica role.

Product Availability

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

Parameters:

replicaRole - A com.esri.arcgis.geodatabase.esriReplicaRole constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRole

int getRole()
            throws IOException,
                   AutomationException

The replica role.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaRole constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessType

void setAccessType(int accessType)
                   throws IOException,
                          AutomationException

Replica access type.

Product Availability

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

Parameters:

accessType - A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccessType

int getAccessType()
                  throws IOException,
                         AutomationException

Replica access type.

Remarks

This property returns a value of the esriReplicaAccessType enumeration indicating the replicas access type. See the esriReplicaAccessType enumeration for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaAccessType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreationDate

void setCreationDate(Object replicaRole)
                     throws IOException,
                            AutomationException

The date the replica was created.

Product Availability

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

Parameters:

replicaRole - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException

The date the replica was created.

Remarks

The replica creation date.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaVersion

void setReplicaVersion(String replicaVersion)
                       throws IOException,
                              AutomationException

The name of the replica version.

Product Availability

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

Parameters:

replicaVersion - The replicaVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaVersion

String getReplicaVersion()
                         throws IOException,
                                AutomationException

The name of the replica version.

Description

The version the replica was created from.

Product Availability

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

Returns:

The replicaVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMyGenerationNumber

void setMyGenerationNumber(int pMyGenerationNumber)
                           throws IOException,
                                  AutomationException

The generation number for the replica.

Product Availability

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

Parameters:

pMyGenerationNumber - The pMyGenerationNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMyGenerationNumber

int getMyGenerationNumber()
                          throws IOException,
                                 AutomationException

The generation number for the replica.

Remarks

Returns the current generation number of a replica.

Product Availability

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

Returns:

The pMyGenerationNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSibGenerationNumber

void setSibGenerationNumber(int pSibGenerationNumber)
                            throws IOException,
                                   AutomationException

The generation number of the relative replica.

Product Availability

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

Parameters:

pSibGenerationNumber - The pSibGenerationNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSibGenerationNumber

int getSibGenerationNumber()
                           throws IOException,
                                  AutomationException

The generation number of the relative replica.

Remarks

Returns the generation number for a replica's sibling as it is known to the replica.

The generation number returned is based on the replicas last received message from it's relative.

Product Availability

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

Returns:

The pSibGenerationNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSibMyGenerationNumber

void setSibMyGenerationNumber(int pSibMyGenerationNumber)
                              throws IOException,
                                     AutomationException

The last generation number that has been acknowledged by the relative replica.

Product Availability

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

Parameters:

pSibMyGenerationNumber - The pSibMyGenerationNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSibMyGenerationNumber

int getSibMyGenerationNumber()
                             throws IOException,
                                    AutomationException

The last generation number that has been acknowledged by the relative replica.

Remarks

Returns the generation number that the sibling thinks is the replicas generation number.

The generation number returned is based on the replicas last received acknowledgement message from it's relative.

Product Availability

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

Returns:

The pSibMyGenerationNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaState

void setReplicaState(int replicaState)
                     throws IOException,
                            AutomationException

The replica state.

Product Availability

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

Parameters:

replicaState - A com.esri.arcgis.geodatabase.esriReplicaState constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaState

int getReplicaState()
                    throws IOException,
                           AutomationException

The replica state.

Remarks

Returns the replica state as a value of the esriReplicaState enumeration. See the esriReplicaState enumeration for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaState constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSibConnectionString

void setSibConnectionString(String sibConnectionString)
                            throws IOException,
                                   AutomationException

The connection string of the relative replica.

Remarks

Use this method to set the connection string of the relative replicas geodatabase.

Product Availability

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

Parameters:

sibConnectionString - The sibConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSibConnectionString

String getSibConnectionString()
                              throws IOException,
                                     AutomationException

The connection string of the relative replica.

Remarks

Returns the connection string to the sibling replica database if it has been set.

Product Availability

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

Returns:

The sibConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaDescriptionByRef

void setReplicaDescriptionByRef(IGPReplicaDescription replicaDescription)
                                throws IOException,
                                       AutomationException

The replica description for the replica.

Product Availability

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

Parameters:

replicaDescription - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaDescription

IGPReplicaDescription getReplicaDescription()
                                            throws IOException,
                                                   AutomationException

The replica description for the replica.

Remarks

Returns the replica description. See the GPReplicaDescription coclass for more information.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReconcilePolicy

void setReconcilePolicy(int policy)
                        throws IOException,
                               AutomationException

The replica reconcile policy.

Product Availability

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

Parameters:

policy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReconcilePolicy

int getReconcilePolicy()
                       throws IOException,
                              AutomationException

The replica reconcile policy.

Remarks

Returns the replica reconcile policy as a value of the esriReplicaReconcilePolicyType enumeration. See the esriReplicaReconcilePolicyType enumeration for more information.

This property will always return esriReplicaReconcilePolicyNone as reconcile policies are not stored with the replica. Reconcile policies are specified at synchronization time. See the IGeoDataServer::ImportReplicaDataChanges and IReplicationAgent::SynchronizeReplica methods for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasConflicts

void setHasConflicts(boolean hasConflicts)
                     throws IOException,
                            AutomationException

Indicates if the replica is in conflict.

Product Availability

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

Parameters:

hasConflicts - The hasConflicts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasConflicts

boolean isHasConflicts()
                       throws IOException,
                              AutomationException

Indicates if the replica is in conflict.

Product Availability

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

Returns:

The hasConflicts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.