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

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

public class DeleteCodedValueFromDomain
extends AbstractGPTool

Removes a value from a coded value domain. The Delete Coded Value From Domain tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DeleteCodedValueFromDomain()
          Creates the Delete Coded Value From Domain tool with defaults.
DeleteCodedValueFromDomain(Object inWorkspace, String domainName, Object code)
          Creates the Delete Coded Value From Domain tool with the required parameters.
 
Method Summary
 Object getCode()
          Returns the Code Value parameter of this tool .
 String getDomainName()
          Returns the Domain Name parameter of this tool .
 Object getInWorkspace()
          Returns the Input Workspace parameter of this tool .
 Object getOutWorkspace()
          Returns the Output Workspace parameter of this tool (Read only).
 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 setCode(Object code)
          Sets the Code Value parameter of this tool .
 void setDomainName(String domainName)
          Sets the Domain Name parameter of this tool .
 void setInWorkspace(Object inWorkspace)
          Sets the Input Workspace 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

DeleteCodedValueFromDomain

public DeleteCodedValueFromDomain()
Creates the Delete Coded Value From Domain tool with defaults.

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


DeleteCodedValueFromDomain

public DeleteCodedValueFromDomain(Object inWorkspace,
                                  String domainName,
                                  Object code)
Creates the Delete Coded Value From Domain 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:
inWorkspace - Workspace, the workspace containing the domain to be updated.
domainName - String, the name of the coded value domain to be updated.
code - String, the value(s) to be deleted from the specified domain. The Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model.
Method Detail

getInWorkspace

public Object getInWorkspace()
Returns the Input Workspace parameter of this tool . This parameter is Workspace, the workspace containing the domain to be updated. This is a required parameter.

Returns:
the Input Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)
Sets the Input Workspace parameter of this tool . This parameter is Workspace, the workspace containing the domain to be updated. This is a required parameter.

Parameters:
inWorkspace - Workspace, the workspace containing the domain to be updated.

getDomainName

public String getDomainName()
Returns the Domain Name parameter of this tool . This parameter is String, the name of the coded value domain to be updated. This is a required parameter.

Returns:
the Domain Name

setDomainName

public void setDomainName(String domainName)
Sets the Domain Name parameter of this tool . This parameter is String, the name of the coded value domain to be updated. This is a required parameter.

Parameters:
domainName - String, the name of the coded value domain to be updated.

getCode

public Object getCode()
Returns the Code Value parameter of this tool . This parameter is String, the value(s) to be deleted from the specified domain. The Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Returns:
the Code Value

setCode

public void setCode(Object code)
Sets the Code Value parameter of this tool . This parameter is String, the value(s) to be deleted from the specified domain. The Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Parameters:
code - String, the value(s) to be deleted from the specified domain. The Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model.

getOutWorkspace

public Object getOutWorkspace()
Returns the Output Workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Workspace

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