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, java.io.Serializable

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

COM Class 'GpDescribeField'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Geoprocessing DescribeField object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGpDescribeField
DISPID_1_GET_NAME, DISPID_1_PUT_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_12_NAME, DISPID_13_NAME, DISPID_14_GET_NAME, DISPID_14_PUT_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_GET_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IID95c402e9_4fe5_4eb5_9ecb_bd009bc4b039, xxDummy
 
Constructor Summary
GpDescribeField()
          Constructs a GpDescribeField using ArcGIS Engine.
GpDescribeField(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpDescribeField theGpDescribeField = (GpDescribeField) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getAliasName()
          Alias name of the field description.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getDomain()
          Domain of the field description.
 java.lang.String getEditable()
          Indicates whether the field is editable.
 IField getField()
          Get the initial field value.
 java.lang.String getIsNullable()
          Indicates whether the field supports NULL values.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLength()
          The length of the field.
 java.lang.String getName()
          Name of the field description.
 int getPosition()
          Set the field position.
 int getPrecision()
          The precision of the field.
 java.lang.String getRequired()
          Indicates whether the field is required.
 int getScale()
          The scale of the field.
 java.lang.String getType()
          The data type of the field.
 int hashCode()
          the hashcode for this object
 void release()
          Release a GpDescribeField.
 void setAliasName(java.lang.String name)
          Alias name of the field description.
 void setDomain(java.lang.String name)
          Domain of the field description.
 void setEditable(java.lang.String editable)
          Indicates whether the field is editable.
 void setField(IField field)
          Set the initial field value.
 void setIsNullable(java.lang.String isNullable)
          Indicates whether the field supports NULL values.
 void setLength(int length)
          The length of the field.
 void setName(java.lang.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(java.lang.String required)
          Indicates whether the field is required.
 void setScale(int scale)
          The scale of the field.
 void setType(java.lang.String type)
          The data type of the field.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GpDescribeField

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GpDescribeField

public GpDescribeField(java.lang.Object obj)
                throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GpDescribeField.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

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

setName

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

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

getAliasName

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

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

setAliasName

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

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

getDomain

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

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

setDomain

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

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

getEditable

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

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

setEditable

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

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

getIsNullable

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

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

setIsNullable

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

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

getRequired

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

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

setRequired

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

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

getLength

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

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

setLength

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

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

getPrecision

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

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

setPrecision

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

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

getScale

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

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

setScale

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

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

getType

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

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

setType

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

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

setField

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

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

getField

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

Specified by:
getField in interface IGpDescribeField
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPosition

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

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

getPosition

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

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