com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class ExportAcknowledgementMessage

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.ExportAcknowledgementMessage

All Implemented Interfaces:

GPTool

public class ExportAcknowledgementMessage
extends AbstractGPTool

Creates an output acknowledgement file to acknowledge the reception of previously received data change messages. The Export Acknowledgement Message tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is used when synchronizing replica while disconnected. This is done by first running the tool which creates a delta file with changes to synchronize. The delta file is then copied to the relative replica and imported using the tool. If a delta file gets lost and you want to resend, you can use the tool to regenerate the delta file. After the changes are imported, the relative replica can export an acknowledgement file using the tool. The acknowledgment file is copied to the replica and imported using the tool. If an acknowledgement is not received, the next time changes are sent they will include the new changes plus the previously sent changes.
• The geodatabase may be a local geodatabase or a geodata service.
• The output acknowledgement file must be XML.
• This tool is not applicable for check-out replicas.
• To synchronize replicas in a connected mode see the tool.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ExportAcknowledgementMessage()
Creates the Export Acknowledgement Message tool with defaults.

ExportAcknowledgementMessage(Object inGeodatabase, Object outAcknowledgementFile, String inReplica)
Creates the Export Acknowledgement Message tool with the required parameters.

Method Summary

Object	getInGeodatabase() Returns the Export from Replica Geodatabase parameter of this tool .
String	getInReplica() Returns the Replica parameter of this tool .
Object	getOutAcknowledgementFile() Returns the Output Acknowledgement File parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInGeodatabase(Object inGeodatabase) Sets the Export from Replica Geodatabase parameter of this tool .
void	setInReplica(String inReplica) Sets the Replica parameter of this tool .
void	setOutAcknowledgementFile(Object outAcknowledgementFile) Sets the Output Acknowledgement File parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportAcknowledgementMessage

public ExportAcknowledgementMessage()

Creates the Export Acknowledgement Message tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

ExportAcknowledgementMessage

public ExportAcknowledgementMessage(Object inGeodatabase,
                                    Object outAcknowledgementFile,
                                    String inReplica)

Creates the Export Acknowledgement Message tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inGeodatabase - specifies the replica geodatabase from which to export the acknowledgement message. The geodatabase may be local or remote.

outAcknowledgementFile - specifies the delta file to export to.

inReplica - the replica from which the acknowledgement message will be exported.

Method Detail

getInGeodatabase

public Object getInGeodatabase()

Returns the Export from Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase from which to export the acknowledgement message. The geodatabase may be local or remote. This is a required parameter.

Returns:

the Export from Replica Geodatabase

setInGeodatabase

public void setInGeodatabase(Object inGeodatabase)

Sets the Export from Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase from which to export the acknowledgement message. The geodatabase may be local or remote. This is a required parameter.

Parameters:

inGeodatabase - specifies the replica geodatabase from which to export the acknowledgement message. The geodatabase may be local or remote.

getOutAcknowledgementFile

public Object getOutAcknowledgementFile()

Returns the Output Acknowledgement File parameter of this tool . This parameter is specifies the delta file to export to. This is a required parameter.

Returns:

the Output Acknowledgement File

setOutAcknowledgementFile

public void setOutAcknowledgementFile(Object outAcknowledgementFile)

Sets the Output Acknowledgement File parameter of this tool . This parameter is specifies the delta file to export to. This is a required parameter.

Parameters:

outAcknowledgementFile - specifies the delta file to export to.

getInReplica

public String getInReplica()

Returns the Replica parameter of this tool . This parameter is the replica from which the acknowledgement message will be exported. This is a required parameter.

Returns:

the Replica

setInReplica

public void setInReplica(String inReplica)

Sets the Replica parameter of this tool . This parameter is the replica from which the acknowledgement message will be exported. This is a required parameter.

Parameters:

inReplica - the replica from which the acknowledgement message will be exported.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias