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

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

All Implemented Interfaces:

GPTool

public class Checkout
extends AbstractGPTool

Creates a check-out replica from datasets in an ArcSDE geodatabase to an ArcSDE, file, or personal geodatabase for offline editing. The Check Out tool is contained in the Data Management Tools tool box.

Usage tips:

• Note that this tool is designed for check-out replicas only and should only be used to support applications from earlier releases. It is recommended that you use the tool in the in place of this tool.
• The tool accepts layers or tables that reference data from one ArcSDE server. Either add them to the list in the dialog box or create a semicolon-delimited list at the command line or in a script.
• The layers and tables must reference versioned ArcSDE feature classes and tables for which you have permissions to edit.
• The following describes how to define the rows to check out:
• This tool applies the default behavior of the create replica command in ArcMap.
• If the Check-out to Workspace parameter value is a personal or file geodatabase that does not exist, one will be created.
• Once replicated, edits may be applied to the child replica geodatabase and synchronized with the parent geodatabase.

Field Summary

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

vals

Constructor Summary

Checkout()
Creates the Check Out tool with defaults.

Checkout(Object inData, Object outWorkspace, String outName)
Creates the Check Out tool with the required parameters.

Method Summary

String	getGetRelatedData() Returns the Check out related data parameter of this tool .
Object	getInData() Returns the Check-out Data parameter of this tool .
String	getInType() Returns the Check-out Type parameter of this tool .
String	getOutName() Returns the Check-out Name parameter of this tool .
Object	getOutWorkspace() Returns the Check-out to Workspace parameter of this tool .
String	getReuseSchema() Returns the Re-use schema if this geodatabase was used for a check-out before 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	setGetRelatedData(String getRelatedData) Sets the Check out related data parameter of this tool .
void	setInData(Object inData) Sets the Check-out Data parameter of this tool .
void	setInType(String inType) Sets the Check-out Type parameter of this tool .
void	setOutName(String outName) Sets the Check-out Name parameter of this tool .
void	setOutWorkspace(Object outWorkspace) Sets the Check-out to Workspace parameter of this tool .
void	setReuseSchema(String reuseSchema) Sets the Re-use schema if this geodatabase was used for a check-out before 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

Checkout

public Checkout()

Creates the Check Out tool with defaults.

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

Checkout

public Checkout(Object inData,
                Object outWorkspace,
                String outName)

Creates the Check Out 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:

inData - the data to be replicated for offline editing. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

outWorkspace - the workspace where the replicated data will be edited. This can be an ArcSDE, file, or personal geodatabase. If it's a personal geodatabase that doesn't exist, it will be created.

outName - the name that identifies the check-out replica. This is recorded and maintained in both the parent and the child database until synchronized.

Method Detail

getInData

public Object getInData()

Returns the Check-out Data parameter of this tool . This parameter is the data to be replicated for offline editing. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase. This is a required parameter.

Returns:

the Check-out Data

setInData

public void setInData(Object inData)

Sets the Check-out Data parameter of this tool . This parameter is the data to be replicated for offline editing. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase. This is a required parameter.

Parameters:

inData - the data to be replicated for offline editing. This list consists of layers and tables referencing versioned, editable data from an ArcSDE geodatabase.

getOutWorkspace

public Object getOutWorkspace()

Returns the Check-out to Workspace parameter of this tool . This parameter is the workspace where the replicated data will be edited. This can be an ArcSDE, file, or personal geodatabase. If it's a personal geodatabase that doesn't exist, it will be created. This is a required parameter.

Returns:

the Check-out to Workspace

setOutWorkspace

public void setOutWorkspace(Object outWorkspace)

Sets the Check-out to Workspace parameter of this tool . This parameter is the workspace where the replicated data will be edited. This can be an ArcSDE, file, or personal geodatabase. If it's a personal geodatabase that doesn't exist, it will be created. This is a required parameter.

Parameters:

outWorkspace - the workspace where the replicated data will be edited. This can be an ArcSDE, file, or personal geodatabase. If it's a personal geodatabase that doesn't exist, it will be created.

getOutName

public String getOutName()

Returns the Check-out Name parameter of this tool . This parameter is the name that identifies the check-out replica. This is recorded and maintained in both the parent and the child database until synchronized. This is a required parameter.

Returns:

the Check-out Name

setOutName

public void setOutName(String outName)

Sets the Check-out Name parameter of this tool . This parameter is the name that identifies the check-out replica. This is recorded and maintained in both the parent and the child database until synchronized. This is a required parameter.

Parameters:

outName - the name that identifies the check-out replica. This is recorded and maintained in both the parent and the child database until synchronized.

getInType

public String getInType()

Returns the Check-out Type parameter of this tool . This parameter is specifies if the data and schema will be replicated or if a SCHEMA-ONLY check-out of the database should occur. The default is DATA. This is an optional parameter.

Returns:

the Check-out Type

setInType

public void setInType(String inType)

Sets the Check-out Type parameter of this tool . This parameter is specifies if the data and schema will be replicated or if a SCHEMA-ONLY check-out of the database should occur. The default is DATA. This is an optional parameter.

Parameters:

inType - specifies if the data and schema will be replicated or if a SCHEMA-ONLY check-out of the database should occur. The default is DATA.

getReuseSchema

public String getReuseSchema()

Returns the Re-use schema if this geodatabase was used for a check-out before parameter of this tool . This parameter is choose REUSE if you are using a database with the schema (no data) as the out_workspace. REUSE will be faster, since a schema will not need to be created during replica creation. The default is NO_REUSE. This is an optional parameter.

Returns:

the Re-use schema if this geodatabase was used for a check-out before

setReuseSchema

public void setReuseSchema(String reuseSchema)

Sets the Re-use schema if this geodatabase was used for a check-out before parameter of this tool . This parameter is choose REUSE if you are using a database with the schema (no data) as the out_workspace. REUSE will be faster, since a schema will not need to be created during replica creation. The default is NO_REUSE. This is an optional parameter.

Parameters:

reuseSchema - choose REUSE if you are using a database with the schema (no data) as the out_workspace. REUSE will be faster, since a schema will not need to be created during replica creation. The default is NO_REUSE.

getGetRelatedData

public String getGetRelatedData()

Returns the Check out related data parameter of this tool . This parameter is specifies whether to replicate related data that has established relationships with the replicated data. For example, consider a feature (f1) inside the replica area and a related feature (f2) from another class outside the replica area. Feature f2 is included in the check-out replica if you choose to get related data. This is an optional parameter.

Returns:

the Check out related data

setGetRelatedData

public void setGetRelatedData(String getRelatedData)

Sets the Check out related data parameter of this tool . This parameter is specifies whether to replicate related data that has established relationships with the replicated data. For example, consider a feature (f1) inside the replica area and a related feature (f2) from another class outside the replica area. Feature f2 is included in the check-out replica if you choose to get related data. This is an optional parameter.

Parameters:

getRelatedData - specifies whether to replicate related data that has established relationships with the replicated data. For example, consider a feature (f1) inside the replica area and a related feature (f2) from another class outside the replica area. Feature f2 is included in the check-out replica if you choose to get related data.

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