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

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

All Implemented Interfaces:

GPTool

public class ImportMessage
extends AbstractGPTool

Imports changes from a delta file into a replica geodatabase, or imports an acknowledgment message into a replica geodatabase. The Import 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.
• Accepts either acknowledgment messages or data change messages. Acknowledgment files are XML (.xml). Data change messages can be delta file geodabase (.gdb), delta personal geodatabase (.mdb) or delta XML files (.xml).
• After importing a data change message, you have the option to immediately export an acknowledgment message. The output acknowledgment file must be XML.
• To synchronize replicas in a connected mode see the tool.

Field Summary

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

vals

Constructor Summary

ImportMessage()
Creates the Import Message tool with defaults.

ImportMessage(Object inGeodatabase, Object sourceDeltaFile)
Creates the Import Message tool with the required parameters.

Method Summary

String	getConflictDefinition() Returns the Conflict Definition parameter of this tool .
String	getConflictPolicy() Returns the Conflict Resolution Policy parameter of this tool .
Object	getInGeodatabase() Returns the Import To Replica Geodatabase parameter of this tool .
Object	getOutGeodatabase() Returns the Output Replica Geodatabase parameter of this tool (Read only).
Object	getOutputAcknowledgementFile() Returns the Output Acknowledgement File parameter of this tool .
String	getReconcileWithParentVersion() Returns the Reconcile with the Parent Version (Check-out replicas) parameter of this tool .
Object	getSourceDeltaFile() Returns the Import from Delta 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	setConflictDefinition(String conflictDefinition) Sets the Conflict Definition parameter of this tool .
void	setConflictPolicy(String conflictPolicy) Sets the Conflict Resolution Policy parameter of this tool .
void	setInGeodatabase(Object inGeodatabase) Sets the Import To Replica Geodatabase parameter of this tool .
void	setOutputAcknowledgementFile(Object outputAcknowledgementFile) Sets the Output Acknowledgement File parameter of this tool .
void	setReconcileWithParentVersion(String reconcileWithParentVersion) Sets the Reconcile with the Parent Version (Check-out replicas) parameter of this tool .
void	setSourceDeltaFile(Object sourceDeltaFile) Sets the Import from Delta 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

ImportMessage

public ImportMessage()

Creates the Import Message tool with defaults.

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

ImportMessage

public ImportMessage(Object inGeodatabase,
                     Object sourceDeltaFile)

Creates the Import 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 to receive the imported message. The geodatabase may be local or remote.

sourceDeltaFile - specifies the file from which the message will be imported.

Method Detail

getInGeodatabase

public Object getInGeodatabase()

Returns the Import To Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase to receive the imported message. The geodatabase may be local or remote. This is a required parameter.

Returns:

the Import To Replica Geodatabase

setInGeodatabase

public void setInGeodatabase(Object inGeodatabase)

Sets the Import To Replica Geodatabase parameter of this tool . This parameter is specifies the replica geodatabase to receive the imported message. The geodatabase may be local or remote. This is a required parameter.

Parameters:

inGeodatabase - specifies the replica geodatabase to receive the imported message. The geodatabase may be local or remote.

getSourceDeltaFile

public Object getSourceDeltaFile()

Returns the Import from Delta file parameter of this tool . This parameter is specifies the file from which the message will be imported. This is a required parameter.

Returns:

the Import from Delta file

setSourceDeltaFile

public void setSourceDeltaFile(Object sourceDeltaFile)

Sets the Import from Delta file parameter of this tool . This parameter is specifies the file from which the message will be imported. This is a required parameter.

Parameters:

sourceDeltaFile - specifies the file from which the message will be imported.

getOutputAcknowledgementFile

public Object getOutputAcknowledgementFile()

Returns the Output Acknowledgement File parameter of this tool . This is an optional parameter.

Returns:

the Output Acknowledgement File

setOutputAcknowledgementFile

public void setOutputAcknowledgementFile(Object outputAcknowledgementFile)

Sets the Output Acknowledgement File parameter of this tool . This is an optional parameter.

Parameters:

outputAcknowledgementFile - null

getConflictPolicy

public String getConflictPolicy()

Returns the Conflict Resolution Policy parameter of this tool . This parameter is specifies how conflicts are resolved when they are encountered while importing a data change message. This is an optional parameter.

Returns:

the Conflict Resolution Policy

setConflictPolicy

public void setConflictPolicy(String conflictPolicy)

Sets the Conflict Resolution Policy parameter of this tool . This parameter is specifies how conflicts are resolved when they are encountered while importing a data change message. This is an optional parameter.

Parameters:

conflictPolicy - specifies how conflicts are resolved when they are encountered while importing a data change message.

getConflictDefinition

public String getConflictDefinition()

Returns the Conflict Definition parameter of this tool . This parameter is specifies how you would like to define conflicts: This is an optional parameter.

Returns:

the Conflict Definition

setConflictDefinition

public void setConflictDefinition(String conflictDefinition)

Sets the Conflict Definition parameter of this tool . This parameter is specifies how you would like to define conflicts: This is an optional parameter.

Parameters:

conflictDefinition - specifies how you would like to define conflicts:

getReconcileWithParentVersion

public String getReconcileWithParentVersion()

Returns the Reconcile with the Parent Version (Check-out replicas) parameter of this tool . This parameter is indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas. This is an optional parameter.

Returns:

the Reconcile with the Parent Version (Check-out replicas)

setReconcileWithParentVersion

public void setReconcileWithParentVersion(String reconcileWithParentVersion)

Sets the Reconcile with the Parent Version (Check-out replicas) parameter of this tool . This parameter is indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas. This is an optional parameter.

Parameters:

reconcileWithParentVersion - indicates whether to automatically reconcile once data changes are sent to the parent replica if there are no conflicts present. This option is only available for check-out/check-in replicas.

getOutGeodatabase

public Object getOutGeodatabase()

Returns the Output Replica Geodatabase parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Replica Geodatabase

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