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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


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 - Workspace |GeoDataServer|GPComposite, specifies the replica geodatabase from which to export the acknowledgement message. The geodatabase may be local or remote.
outAcknowledgementFile - File, specifies the delta file to export to.
inReplica - String, 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 Workspace |GeoDataServer|GPComposite, 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 Workspace |GeoDataServer|GPComposite, 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 - Workspace |GeoDataServer|GPComposite, 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 File, 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 File, specifies the delta file to export to. This is a required parameter.

Parameters:
outAcknowledgementFile - File, specifies the delta file to export to.

getInReplica

public String getInReplica()
Returns the Replica parameter of this tool . This parameter is String, 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 String, the replica from which the acknowledgement message will be exported. This is a required parameter.

Parameters:
inReplica - String, 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