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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.ExportReplicaSchema
All Implemented Interfaces:
GPTool

public class ExportReplicaSchema
extends AbstractGPTool

Creates a replica schema file with the schema of an input one or two-way replica. The Export Replica Schema 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
ExportReplicaSchema()
          Creates the Export Replica Schema tool with defaults.
ExportReplicaSchema(Object inGeodatabase, Object outputReplicaSchemaFile, String inReplica)
          Creates the Export Replica Schema 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 getOutputReplicaSchemaFile()
          Returns the Output Replica Schema 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 setOutputReplicaSchemaFile(Object outputReplicaSchemaFile)
          Sets the Output Replica Schema 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

ExportReplicaSchema

public ExportReplicaSchema()
Creates the Export Replica Schema tool with defaults.

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


ExportReplicaSchema

public ExportReplicaSchema(Object inGeodatabase,
                           Object outputReplicaSchemaFile,
                           String inReplica)
Creates the Export Replica Schema 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|GPComposite type, specifies the replica geodatabase from which to export the replica schema from. The geodatabase may be local or remote.
outputReplicaSchemaFile - File, specifies the file in which to export schema.
inReplica - String, the replica from which to export schema.
Method Detail

getInGeodatabase

public Object getInGeodatabase()
Returns the Export from Replica Geodatabase parameter of this tool . This parameter is Workspace|GPComposite type, specifies the replica geodatabase from which to export the replica schema from. 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|GPComposite type, specifies the replica geodatabase from which to export the replica schema from. The geodatabase may be local or remote. This is a required parameter.

Parameters:
inGeodatabase - Workspace|GPComposite type, specifies the replica geodatabase from which to export the replica schema from. The geodatabase may be local or remote.

getOutputReplicaSchemaFile

public Object getOutputReplicaSchemaFile()
Returns the Output Replica Schema File parameter of this tool . This parameter is File, specifies the file in which to export schema. This is a required parameter.

Returns:
the Output Replica Schema File

setOutputReplicaSchemaFile

public void setOutputReplicaSchemaFile(Object outputReplicaSchemaFile)
Sets the Output Replica Schema File parameter of this tool . This parameter is File, specifies the file in which to export schema. This is a required parameter.

Parameters:
outputReplicaSchemaFile - File, specifies the file in which to export schema.

getInReplica

public String getInReplica()
Returns the Replica parameter of this tool . This parameter is String, the replica from which to export schema. 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 to export schema. This is a required parameter.

Parameters:
inReplica - String, the replica from which to export schema.

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