com.esri.arcgis.geoprocessing
Interface IGpDescribeField

All Superinterfaces:
Serializable
All Known Implementing Classes:
GpDescribeField

public interface IGpDescribeField
extends Serializable

Provides access to the properties of a Geoprocessing Field Description object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 String getAliasName()
          Alias name of the field description.
 String getDomain()
          Domain of the field description.
 String getEditable()
          Indicates whether the field is editable.
 IField getField()
          Get the initial field value.
 String getIsNullable()
          Indicates whether the field supports NULL values.
 int getLength()
          The length of the field.
 String getName()
          Name of the field description.
 int getPosition()
          Set the field position.
 int getPrecision()
          The precision of the field.
 String getRequired()
          Indicates whether the field is required.
 int getScale()
          The scale of the field.
 String getType()
          The data type of the field.
 void setAliasName(String name)
          Alias name of the field description.
 void setDomain(String name)
          Domain of the field description.
 void setEditable(String editable)
          Indicates whether the field is editable.
 void setField(IField field)
          Set the initial field value.
 void setIsNullable(String isNullable)
          Indicates whether the field supports NULL values.
 void setLength(int length)
          The length of the field.
 void setName(String name)
          Name of the field description.
 void setPosition(int pos)
          Set the field position.
 void setPrecision(int precision)
          The precision of the field.
 void setRequired(String required)
          Indicates whether the field is required.
 void setScale(int scale)
          The scale of the field.
 void setType(String type)
          The data type of the field.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException
Name of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAliasName

String getAliasName()
                    throws IOException,
                           AutomationException
Alias name of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAliasName

void setAliasName(String name)
                  throws IOException,
                         AutomationException
Alias name of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomain

String getDomain()
                 throws IOException,
                        AutomationException
Domain of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomain

void setDomain(String name)
               throws IOException,
                      AutomationException
Domain of the field description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEditable

String getEditable()
                   throws IOException,
                          AutomationException
Indicates whether the field is editable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The editable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEditable

void setEditable(String editable)
                 throws IOException,
                        AutomationException
Indicates whether the field is editable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
editable - The editable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIsNullable

String getIsNullable()
                     throws IOException,
                            AutomationException
Indicates whether the field supports NULL values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The isNullable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsNullable

void setIsNullable(String isNullable)
                   throws IOException,
                          AutomationException
Indicates whether the field supports NULL values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
isNullable - The isNullable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRequired

String getRequired()
                   throws IOException,
                          AutomationException
Indicates whether the field is required.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The required
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRequired

void setRequired(String required)
                 throws IOException,
                        AutomationException
Indicates whether the field is required.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
required - The required (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLength

int getLength()
              throws IOException,
                     AutomationException
The length of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The length
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLength

void setLength(int length)
               throws IOException,
                      AutomationException
The length of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
length - The length (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrecision

int getPrecision()
                 throws IOException,
                        AutomationException
The precision of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The precision
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrecision

void setPrecision(int precision)
                  throws IOException,
                         AutomationException
The precision of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
precision - The precision (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScale

int getScale()
             throws IOException,
                    AutomationException
The scale of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScale

void setScale(int scale)
              throws IOException,
                     AutomationException
The scale of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

String getType()
               throws IOException,
                      AutomationException
The data type of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The type
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

void setType(String type)
             throws IOException,
                    AutomationException
The data type of the field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
type - The type (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setField

void setField(IField field)
              throws IOException,
                     AutomationException
Set the initial field value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

IField getField()
                throws IOException,
                       AutomationException
Get the initial field value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPosition

void setPosition(int pos)
                 throws IOException,
                        AutomationException
Set the field position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pos - The pos (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPosition

int getPosition()
                throws IOException,
                       AutomationException
Set the field position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.