com.esri.arcgis.geoprocessing
Class GpDescribeField

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GpDescribeField
All Implemented Interfaces:
IGpDescribeField, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GpDescribeField
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpDescribeField

Geoprocessing DescribeField object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GpDescribeField()
          Constructs a GpDescribeField using ArcGIS Engine.
GpDescribeField(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpDescribeField theGpDescribeField = (GpDescribeField) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getAliasName()
          Alias name of the field description.
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GpDescribeField

public GpDescribeField()
                throws IOException,
                       UnknownHostException
Constructs a GpDescribeField using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GpDescribeField

public GpDescribeField(Object obj)
                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpDescribeField theGpDescribeField = (GpDescribeField) obj;

Construct a GpDescribeField using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GpDescribeField.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

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

Product Availability

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

Specified by:
getName in interface IGpDescribeField
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

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

Product Availability

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

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

getAliasName

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

Product Availability

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

Specified by:
getAliasName in interface IGpDescribeField
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAliasName

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

Product Availability

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

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

getDomain

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

Product Availability

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

Specified by:
getDomain in interface IGpDescribeField
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDomain

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

Product Availability

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

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

getEditable

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

Product Availability

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

Specified by:
getEditable in interface IGpDescribeField
Returns:
The editable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEditable

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

Product Availability

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

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

getIsNullable

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

Product Availability

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

Specified by:
getIsNullable in interface IGpDescribeField
Returns:
The isNullable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsNullable

public 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.

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

getRequired

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

Product Availability

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

Specified by:
getRequired in interface IGpDescribeField
Returns:
The required
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRequired

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

Product Availability

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

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

getLength

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

Product Availability

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

Specified by:
getLength in interface IGpDescribeField
Returns:
The length
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLength

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

Product Availability

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

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

getPrecision

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

Product Availability

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

Specified by:
getPrecision in interface IGpDescribeField
Returns:
The precision
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrecision

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

Product Availability

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

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

getScale

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

Product Availability

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

Specified by:
getScale in interface IGpDescribeField
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScale

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

Product Availability

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

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

getType

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

Product Availability

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

Specified by:
getType in interface IGpDescribeField
Returns:
The type
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setType

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

Product Availability

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

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

setField

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

Product Availability

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

Specified by:
setField in interface IGpDescribeField
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

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

Product Availability

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

Specified by:
getField in interface IGpDescribeField
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

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

Product Availability

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

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

getPosition

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

Product Availability

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

Specified by:
getPosition in interface IGpDescribeField
Returns:
The pos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.