com.esri.arcgis.geodatabasedistributed
Interface IReplicaMessageHandler

All Superinterfaces:
Serializable
All Known Implementing Classes:
ReplicaMessageHandler

public interface IReplicaMessageHandler
extends Serializable

Provides access to members that return information about a replica data change message.

Remarks

The IReplicaMessageHandler interface is the only interface on the ReplicaMessageHandler coclass.

This interface can be used to retrieve information about a given replica data change message. The ReplicaMessageHandler object must be initialized with the init method before you can retrieve any of its properties or be used as input to other methods.

Product Availability

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


Method Summary
 IDeltaDataChanges getDeltaDataChanges()
          Delta data changes.
 int getMessageType()
          Replica message type.
 int getMyGenerationNumber()
          Replica generation number.
 String getReplicaGuid()
          Replica guid.
 int getSibGenerationNumber()
          Replica sibling generation number.
 void init(String msgFileName, int msgExportOption)
          Init replica message handler.
 

Method Detail

init

void init(String msgFileName,
          int msgExportOption)
          throws IOException,
                 AutomationException
Init replica message handler.

Remarks

This method initializes the ReplicMessageHandler coclass.

The init method takes an MsgFileName as a string and the MsgExportOption as the data changes option. The MsgFileName parameter is the replica data changes file. This may be a delta XML file, delta database, or a delta file geodatabase. The MsgExportOption parameter specifies the type of replica data changes file. See esriExportDataChangesOption for more information.

Product Availability

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

Parameters:
msgFileName - The msgFileName (in)
msgExportOption - A com.esri.arcgis.geodatabasedistributed.esriExportDataChangesOption constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaGuid

String getReplicaGuid()
                      throws IOException,
                             AutomationException
Replica guid.

Remarks

This property returns the Replica Guid contained in the Message initialized with the ReplicaMessageHandler object.

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.

getMessageType

int getMessageType()
                   throws IOException,
                          AutomationException
Replica message type.

Remarks

This property returns the message type of the message file initialized with the ReplicaMessageHandler object. The message can be either a data change message, a data change message with a switch message, or an acknowledgement message. The message type is returned as a value representing the esriReplicaMessageType. See the esriReplicaMessageType enumeration for more information.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabasedistributed.esriReplicaMessageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMyGenerationNumber

int getMyGenerationNumber()
                          throws IOException,
                                 AutomationException
Replica generation number.

Remarks

This property returns the generation number of the replica which generated the message file that was initialized with the ReplicaMessageHandler object.

Product Availability

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

Returns:
The generationNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSibGenerationNumber

int getSibGenerationNumber()
                           throws IOException,
                                  AutomationException
Replica sibling generation number.

Remarks

This property returns the generation number of the relative replica which generated the message file that was initialized with the ReplicaMessageHandler object.

Product Availability

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

Returns:
The sibGen
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDeltaDataChanges

IDeltaDataChanges getDeltaDataChanges()
                                      throws IOException,
                                             AutomationException
Delta data changes.

Remarks

This property returns the DeltaDataChanges as IDeltaDataChanges in the message initialized with the ReplicaMessageHandler. See DeltaDataChanges for more information.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabasedistributed.IDeltaDataChanges
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.